---
title: "Get path"
method: GET
path: "/v2/paths/{id}"
tags: ["Paths"]
---

# Get path

`GET /v2/paths/{id}`

## Request

- Base URL: `https://api.skilljar.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.skilljar.com/v2/paths/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/paths/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve one path by id.

**Required OAuth scope:** `paths:read`

## Path parameters

- `id` string, required

## Response `200`

OK

- PathDetailResponse: JSON:API single-resource response for a path.
  - `data` PathResource, required: JSON:API resource object for a path.
    - `type` string: Always "paths".
    - `id` string, required: Opaque path ID. Use in URL paths.
    - `attributes` PathAttributes, required: Attributes of a path resource object.
      - `external_id` string, required: Stable UUID5 for cross-system correlation.
      - `title` string, required: Path title.
      - `short_description` string, required: Short description shown on path tiles.
      - `long_description_html` string, required: Long description as HTML content.
      - `header_html` string, required: HTML shown at the top of the path page in the catalog.
      - `course_name_singular` string, required: Label that replaces 'Course' on the catalog tile.
      - `course_name_plural` string, required: Label that replaces 'Courses' on the catalog tile.
      - `promo_image_url` string, required: Promo image URL, or "" if no image is set.
      - `path_item_count` integer, required: Number of items in the path.
      - `created_at` string, date-time, required: Creation timestamp.
      - `modified_at` string, date-time, required: Latest update to the path or any of its items.
    - `links` object, nullable: Self link.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `406`: Not Acceptable: Accept rules out application/vnd.api+json.

## Changes

- **2026-10-21** `16a566965a72`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/skilljar/apis/skilljar-api-v2/changes/v2/paths/:id/get.md)

---

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