---
title: "List paths"
method: GET
path: "/v2/paths/"
tags: ["Paths"]
---

# List paths

`GET /v2/paths/`

## 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/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/paths/get.ts> (a function with typed inputs; its response is checked against the schema)

List the organization's paths.

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

## Query parameters

- `page[size]` integer: Maximum number of records to return. Values above 100 are served as 100; values below 1 are served as 1.
- `page[cursor]` string, nullable: Opaque cursor from the previous page's links.next.
- `filter[title]` string, nullable: Case-insensitive partial match on path title.

## Response `200`

OK

- PaginatedListResponsePathResource
  - `data` PathResource[], required: The resources on this page, in cursor order.
    - `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.
  - `meta` object, nullable: Pagination metadata, e.g. {"page_size": 25}.
  - `links` PaginationLinks: JSON:API §Links object for a paginated collection. Typed rather than a free-form ``dict`` so ``next`` reaches the generated OpenAPI/SDK/MCP contract. Since GE-256227 removed the top-level ``next_cursor``, ``links.next`` is the only pagination affordance a machine consumer has — an untyped ``dict`` would leave it undiscoverable.
    - `self` string, nullable: Path of the current request, relative and without its query string (so every page of a filtered collection reports the same value).
    - `next` string, nullable: Relative path of the next page, ready to request as-is. Carries ``page[cursor]`` plus every non-cursor query param from the current request (``page[size]``, ``filter[*]``, ``include``). Null on the last page.
    - `prev` string, nullable: Relative path of the previous page. Not implemented — currently always null.
  - `included` object[], nullable: Related resources requested via ?include=. Absent when no include was requested.

## Other responses

- `400`: Bad Request: page[cursor] is not a valid cursor.
- `401`: Unauthorized
- `403`: Forbidden
- `406`: Not Acceptable: Accept rules out application/vnd.api+json.
- `422`: Unprocessable Entity

## Changes

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

[Operation history](https://skmtc.dev/skilljar/apis/skilljar-api-v2/changes/v2/paths/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)