Badge

Read Badge Alignment

Changed on Aug 6, 2026

Get an array of alignment for a badge.

get/v1/badge/{badge_id}/alignment

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
TypeScript
https://skmtc.dev/navigatr/apis/navigatr-api/docs/v1/badge/:badge_id/alignment/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

external_idstring nullable

namestring nullable

descriptionstring nullable

urlstring nullable

frameworkstring nullable

codestring nullable

idinteger nullable

badge_idinteger nullable

Example response

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

Changes

Aug 6, 20264039d06e340b Revision changes
- info
  api operation id read_badge_alignment_v1_badge__badge_id__alignment_get removed and replaced with badge_read_badge_alignment
- 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
Nov 20, 20256eb631bcc695 Revision changes
- 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/code 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/framework 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/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

Operation history