---
title: "Read Badge Alignment"
method: GET
path: "/v1/badge/{badge_id}/alignment"
tags: ["Badge"]
---

# Read Badge Alignment

`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)
- URL: `https://api.navigatr.app/v1/badge/{badge_id}/alignment`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/token`

Get an array of alignment for a badge.

## Path parameters

- `badge_id` integer, required

## Headers

- `X-Access-Token` string, nullable

## Response `200`

Successful Response

- BadgeAlignment[]
  - `external_id` string, nullable
  - `name` string, nullable
  - `description` string, nullable
  - `url` string, nullable
  - `framework` string, nullable
  - `code` string, nullable
  - `id` integer, nullable
  - `badge_id` integer, nullable

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `410`: Gone
- `422`: Validation Error

## Changes

- **2026-08-06** `4039d06e340b`: 5 info
  - api operation id `read_badge_alignment_v1_badge__badge_id__alignment_get` removed and replaced with `badge_read_badge_alignment`
  - added the new optional `header` request parameter `X-Access-Token`
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
  - …1 more
- **2025-11-20** `6eb631bcc695`: 8 breaking
  - response property `items/badge_id` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/code` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/description` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/external_id` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …4 more

[Operation history](https://skmtc.dev/navigatr/apis/navigatr-api/changes/v1/badge/:badge_id/alignment/get.md)

---

[API](https://skmtc.dev/navigatr/apis/navigatr-api.md) - [All operations](https://skmtc.dev/navigatr/apis/navigatr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/navigatr/apis/navigatr-api/revisions/efbd3c328549?raw)