v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB

Badge

Read Badges

Retrieve an array of badges filtered by a Provider, Community, QA Community or a Badge Issuer. Only one value is required. On the public API, authentication is required and only badges for the current user's own provider or community may be listed. Optional parameters may be passed to filter the query.

Results can be ordered by name or time_created, either ascending or descending by passing a value into order_by. See below. By default, badges are ordered alphabetically.

Filter	Description
provider_id (int)	Set the provider ID to get the badges that belong to a specific provider. You can find your provider ID in the URL of your provider profile.
community_id (int)	Set the community ID to get the badges that belong to a specific community. You can find your community ID in the URL of your community profile.
qa_community_id (int)	Set the QA community ID to get the badges that belong to a specific QA community.
issuer_id (int)	Set the issuer ID to get the badges that belong to a specific issuer. This is a rarely used filter.
status (string)	A comma separated list of badge statuses. Filter badges by status. If none are provided, all statuses the current user has access to will be returned.
keyword (string)	Get badges with names similar to the provided string.
featured (bool)	Get only featured or unfeatured badges.
qa_required (bool)	Get only badges that require quality assurance.
type (Badge_Type)	Get only badges of a certain type. See below for the available types
source (Source_Type)	Get only badges of a certain sort. See below for available sources

Badge_Status:

Initialising, Draft, Awaiting_Approval, Published, Expired, Deleted

Badge_Type:

Generic Types:

    Experience, Learning, Validation, Certification, Attendance, Work_Experience, Volunteering, Job,
    Apprenticeship, Course, Membership, Internship, Workshop, Campaigning, Activism, Other

Navigatr Standard Types:

    Informal_Learning, Training, Certified, Qualification, Membership

Recipient_Type:

User, Organisation

Source_Type:

Internal, Credly

Badge_Order_By:

Time_Created_Asc, Time_Created_Desc, Name_Asc, Name_Desc

get/v1/badge/

Query parameters

issuer_idinteger

community_idinteger

qa_community_idinteger

provider_idinteger

featuredboolean

qa_requiredboolean

recipient_type'User' | 'Organisation'

sourcestring

keywordstring

statusstring

paginatedboolean

pageinteger

sizeinteger

Headers

X-Access-Tokenstring nullable

Response

Successful Response

Example response

{
  "items": [
    {
      "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",
      "created_by": {
        "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",
        "interests": [
          "Coding, Web Development, Engineering"
        ]
      },
      "submitted_by": {
        "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",
        "interests": [
          "Coding, Web Development, Engineering"
        ]
      },
      "published_by": {
        "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",
        "interests": [
          "Coding, Web Development, Engineering"
        ]
      },
      "updated_by": {
        "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",
        "interests": [
          "Coding, Web Development, Engineering"
        ]
      },
      "criteria": [
        {
          "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
          "description": "Earners must have completed a three stage interview process before they can earn this badge.",
          "external_url": "https://apply.org"
        }
      ],
      "tags": [
        {
          "name": "Test Driven Development"
        }
      ],
      "alignments": [
        {
          "external_id": "123-45678-90",
          "name": "Null Badging Standard - Example Layer",
          "description": "This badge has been mapped to the Example Layer of the Null Badging Standard",
          "url": "https://Null_Badging/Example.org"
        }
      ],
      "endorsements": [
        {
          "external_id": "zyxw-vut-srq-ponmlkjih",
          "name": "Endorsement Example",
          "description": "This is an example of a badge endorsement",
          "url": "https://Endorsement/Example.org",
          "image_url": "https://media.navigatr.app/endorsement.webp",
          "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
          "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
        }
      ],
      "providers": [
        {
          "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"
        }
      ],
      "url": "https://navigatr.app/badge/12345/Learn-Your-ABCs"
    }
  ]
}