v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB

Badge Assertion

Read Badge Assertions

Retrieve an array of badges that has been issued to users. Optional parameters may be passed to filter the query.

Provider and community admins can only access badges issued by their own organisation(s).

Filter	Description
badge_id (integer) - optional	Retrieve the assertions for a certain badge.
provider_id (integer) - optional	Retrieve the assertions issued by a certain provider.
recipient_id (integer) - optional	Retrieve the assertions issued to a certain user.
status (string) - optional	A comma separated list of badge statuses. Filter by badge assertion status. If none are provided, will default to showing all assertions the user has access to.
recipient_email (string) - optional	Get the assertions issued to a certain email address. Only admins can filter by email.
keyword (string) - optional	Get badge assertions for badges with names similar to the provided string.
order_by (string) - optional	By default, badge assertions are ordered by newest first. Results can be ordered by name of badge or time_created, either ascending or descending by passing a value into order_by. See below.

Badge_Assertion_Status:

Pending, Claimed, Revoked, Expired, Deleted

Badge_Assertion_Order_By:

Time_Created_Asc, Time_Created_Desc, Name_Asc, Name_Desc

get/v1/badge_assertion/

Query parameters

recipient_idinteger

badge_idinteger

provider_idinteger

recipient_emailstring

order_by'Time_Created_Asc' | 'Time_Created_Desc' | 'Name_Asc' | 'Name_Desc'

keywordstring

statusstring

paginatedboolean

pageinteger

sizeinteger

Headers

X-Access-Tokenstring nullable

Response

Successful Response

Example response

{
  "items": [
    {
      "recipient_email": "example@user.com",
      "recipient_firstname": "Jane",
      "recipient_lastname": "Doe",
      "recipient_organisation": "XYZ Limited",
      "end_date": "2023-12-02T15:33:32.561Z",
      "image_url": "https://media.navigatr.app/image.webp",
      "image_url_2x": "https://media.navigatr.app/image_2x.webp",
      "issue_date": "2022-12-02T15:33:32.561Z",
      "time_verified": "2022-12-02T15:33:32.561Z",
      "time_claimed": "2022-12-02T15:33:32.561Z",
      "recipient": {
        "firstname": "John",
        "lastname": "Doe",
        "avatar_url": "https://media.navigatr.app/avatar.webp",
        "avatar_url_2x": "https://media.navigatr.app/avatar_2x.webp",
        "avatar_url_original": "https://media.navigatr.app/avatar_original.webp"
      },
      "provider": {
        "name": "Horace's Haberdashery Academy",
        "short_name": "HHA",
        "community": {
          "name": "Fordwich Town Council",
          "short_name": "FTC",
          "image_url": "https://media.navigatr.app/Fordwich.webp",
          "image_url_2x": "https://media.navigatr.app/Fordwich_2x.webp",
          "image_url_original": "https://media.navigatr.app/Fordwich_original.webp",
          "url": "https://navigatr.app/community/5/fordwich-town-council"
        },
        "image_url": "https://media.navigatr.app/HHA.webp",
        "banner_url": "https://media.navigatr.app/HHA_banner.webp",
        "image_url_2x": "https://media.navigatr.app/HHA_2x.webp",
        "banner_url_2x": "https://media.navigatr.app/HHA_banner_2x.webp",
        "image_url_original": "https://media.navigatr.app/HHA_original.webp",
        "banner_url_original": "https://media.navigatr.app/HHA_banner_original.webp",
        "url": "https://navigatr.app/provider/2922/horaces-haberdashery"
      },
      "badge": {
        "name": "Learn your ABCs",
        "description": "This badge is awarded to earners who have demonstrated their knowledge of all letters of the English alphabet.",
        "image_url": "https://media.navigatr.app/image.webp",
        "image_url_2x": "https://media.navigatr.app/image_2x.webp",
        "address": "123 Example Street, Leeds, West Yorkshire, England, LS1 EXA",
        "availability": "This badge is available to students of the University of Leeds",
        "end_date": "2023-11-18T13:33:01.201Z",
        "url": "https://navigatr.app/badge/12345/Learn-Your-ABCs"
      },
      "url": "https://navigatr.app/badge/assertion/123",
      "change_request": [
        {
          "changes": [
            {
              "value": "Joe"
            }
          ],
          "note": "Married last year, updating my surname"
        }
      ]
    }
  ]
}