Badge

Read Badge Endorsements

Changed on

Get an array of endorsement for a badge.

get/v1/badge/{badge_id}/endorsements

Request

  • Base URL
    https://api.navigatr.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL/v1/token

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable
idinteger nullable
badge_idinteger nullable

Example response

[
  {
    "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"
  }
]

Changes

    • info

      api operation id read_badge_endorsements_v1_badge__badge_id__endorsements_get removed and replaced with badge_read_badge_endorsements

    • info

      added the new optional header request parameter X-Access-Token

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from Unauthorized access to Insufficient permissions for the status

    • breaking

      response property items/badge_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/external_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/image_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/image_url_2x list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/image_url_original list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the / response property's maxLength was unset from 65536 for the response status

    • breaking

      the / response property's maxLength was unset from 65536 for the response status

    • breaking

      the / response property's maxLength was unset from 65536 for the response status

    • breaking

      the / response property's maxLength was unset from 65536 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status