Analytics
Recipient Data

Retrieving recipients

To retrieve the profiles of the users who went through the claming flow to add your badge to their profile, you can use the following endpoint:

GET https://www.holopin.io/api/sticker/users?stickerId=<stickerId>&apiKey=<apiKey>&page=<page>

The stickerId and apiKey are required parameters.

The page parameter is optional and defaults to 0. The maximum number of results per page is 72. This means that if you have more than 72 users who claimed your badge, you will need to make multiple requests to retrieve all of them.

Returned badges are sorted by the date they were claimed, with the most recent first.

Success response will have the status code 200, and return a JSON object with the following structure:

{
  "message": "Successfully retrieved claimed stickers",
  "totalCount": 123, // total number of users who claimed your badge,
  "count": 72, // number of users returned in this request,
  "page": 0, // the page number of the returned results,
  "data": [ // an array of user objects
    {
      "id": "abc123", // the user's badge id
      "url": "https://holopin.io/userbadge/abc123", // the url of the user's badge
      "username": "bob1", // the user's username
      "profileUrl": "https://holopin.io/@bob1", // the url of the user's profile
      "profileImageUrl": "https://holopin.io/images/profiles/bob1.png", // the url of the user's profile image, if they have one
      "websiteUrl": "https://holopin.io", // the user's website url
      "githubUrl": "https://github.com/bob1", // the user's github url
      "twitterUrl": "https://twitter.com/bob1", // the user's twitter url
      "createdAt": "2020-10-30T16:00:00.000Z" // the date the user claimed the badge
    },
    ...
    ]
}
Last updated on February 28, 2024
Regular BadgesGitHub Bot