---
title: "Get guide by ID"
method: GET
path: "/api/1/cxuc/guides/{id}"
tags: ["Guides"]
---

# Get guide by ID

`GET /api/1/cxuc/guides/{id}`

## Path parameters

- `id` string, uuid, required

## Query parameters

- `skipEnrichmentCalls` string

## Headers

- `Authorization` string, required

## Response `200`

Guide.
- User JWT / service token → classic `Guide`
- Bynder API token → `GuideWithMissingAssets` (headless)

- union
  - Guide
    - `id` string, uuid
    - `creationTime` string
    - `lastModifiedTime` string
    - `title` string
    - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
    - `version` integer
    - `ownerId` string
    - `cover` object
      - `assetId` string
      - `assetName` string
      - `imageUrl` string
      - `detailUrl` string
    - `isFeatured` boolean
    - `type` 'MULTI_PAGE' | 'SINGLE_PAGE' | 'HOME_PAGE'
    - `groupId` string, uuid
    - `canEdit` boolean
    - `canView` boolean
    - `shared` boolean
    - `targetedPagesEnabled` boolean
    - `chapters` object[]
      - `id` string, uuid
      - `title` string
      - `pages` object[]
        - `id` string, uuid
        - `title` string
        - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
        - `state` 'DRAFT' | 'PUBLISHED'
        - `tableOfContents` TableOfContents
          - `isVisibleInPage` boolean
          - `isVisibleInGuide` boolean
        - `header` PageHeader
          - `asset` object
            - `assetId` string
            - `assetName` string
            - `assetExtension` string
            - `imageUrl` string
            - `detailUrl` string
          - `backgroundColor` string
          - `height` string
          - `textColorId` string
          - `isTitleVisible` boolean
          - `isSubtitleVisible` boolean
          - `isVisible` boolean
        - `canEdit` boolean
        - `canView` boolean
        - `shared` boolean
        - `ownerId` string
        - `creationTime` string
        - `lastModifiedTime` string
      - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
      - `canEdit` boolean
      - `canView` boolean
      - `shared` boolean
      - `ownerId` string
      - `creationTime` string
      - `lastModifiedTime` string
  - GuideWithMissingAssets
    - `guide` object
      - `id` string, uuid
      - `creationTime` string
      - `lastModifiedTime` string
      - `title` string
      - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
      - `version` integer
      - `ownerId` string
      - `cover` object — Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.
        - `id` string
        - `name` string
        - `description` string
        - `type` string
        - `brandId` string
        - `idHash` string
        - `orientation` string
        - `userCreated` string
        - `dateCreated` string
        - `dateModified` string
        - `datePublished` string
        - `copyright` string
        - `original` string
        - `transformBaseUrl` string
        - `extension` string[]
        - `tags` string[]
        - `propertyOptions` string[]
        - `videoPreviewURLs` string[]
        - `isPublic` boolean
        - `archive` boolean
        - `watermarked` boolean
        - `limited` boolean
        - `fileSize` integer
        - `width` integer
        - `height` integer
        - `property_limitedrights` string
        - `thumbnails` object
          - `mini` string
          - `thul` string
          - `webimage` string
        - `mediaItems` object[]
          - `name` string
          - `publicUrl` string
          - `type` string
      - `isFeatured` boolean
      - `type` 'MULTI_PAGE' | 'SINGLE_PAGE' | 'HOME_PAGE'
      - `groupId` string, uuid
      - `targetedPagesEnabled` boolean
      - `chapters` object[]
        - `id` string, uuid
        - `title` string
        - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
        - `ownerId` string
        - `creationTime` string
        - `lastModifiedTime` string
        - `pages` object[]
          - `id` string, uuid
          - `title` string
          - `visibility` 'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
          - `state` 'DRAFT' | 'PUBLISHED'
          - `ownerId` string
          - `creationTime` string
          - `lastModifiedTime` string
    - `missingAssetIds` string[]

## Other responses

- `206` — Guide with some missing asset enrichments (Bynder API token only)
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Guide not found

---

[API](https://skmtc.net/bynder/apis/oauth-2-0.md) · [All operations](https://skmtc.net/bynder/apis/oauth-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bynder/oauth-2-0/versions/bb9efc864ce1/schema)