---
title: "Get guide by ID"
url: "https://earlyaccess.developers.bynder.com/apis/cxuc-1/versions/9a8a4a13-fdd4-455b-8d92-5f16aea67949/operations/getGuideByIdApi"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/cxuc-1/versions/9a8a4a13-fdd4-455b-8d92-5f16aea67949.md

# Get guide by ID

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

Operation ID: `getGuideByIdApi`

## Path parameters

- `id` (string, uuid, required)

## Query parameters

- `skipEnrichmentCalls` (string, optional) - When present, skips asset enrichment calls

## Header parameters

- `Authorization` (string, required)

## Responses

- `200` - Guide. - User JWT / service token → classic `Guide` - Bynder API token → `GuideWithMissingAssets` (headless)
- `206` - Guide with some missing asset enrichments (Bynder API token only)
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Guide not found

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: CXUC
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/cxuc/guides/{id}:
    get:
      operationId: getGuideByIdApi
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: When present, skips asset enrichment calls
          in: query
          name: skipEnrichmentCalls
          required: false
          schema:
            type: string
        - in: header
          name: Authorization
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/Guide"
                  - $ref: "#/components/schemas/GuideWithMissingAssets"
          description: |
            Guide.
            - User JWT / service token → classic `Guide`
            - Bynder API token → `GuideWithMissingAssets` (headless)
        "206":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GuideWithMissingAssets"
          description: Guide with some missing asset enrichments (Bynder API token only)
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
        "404":
          description: Guide not found
      summary: Get guide by ID
      tags:
        - Guides
components:
  schemas:
    Guide:
      properties:
        canEdit:
          type: boolean
        canView:
          type: boolean
        chapters:
          items:
            properties:
              canEdit:
                type: boolean
              canView:
                type: boolean
              creationTime:
                type: string
              id:
                format: uuid
                type: string
              lastModifiedTime:
                type: string
              ownerId:
                type: string
              pages:
                items:
                  properties:
                    canEdit:
                      type: boolean
                    canView:
                      type: boolean
                    creationTime:
                      type: string
                    header:
                      $ref: "#/components/schemas/PageHeader"
                    id:
                      format: uuid
                      type: string
                    lastModifiedTime:
                      type: string
                    ownerId:
                      type: string
                    shared:
                      type: boolean
                    state:
                      $ref: "#/components/schemas/PageState"
                    tableOfContents:
                      $ref: "#/components/schemas/TableOfContents"
                    title:
                      type: string
                    visibility:
                      $ref: "#/components/schemas/Visibility"
                  title: PageOverview
                  type: object
                type: array
              shared:
                type: boolean
              title:
                type: string
              visibility:
                $ref: "#/components/schemas/Visibility"
            title: Chapter
            type: object
          type: array
        cover:
          properties:
            assetId:
              type: string
            assetName:
              type: string
            detailUrl:
              type: string
            imageUrl:
              type: string
          title: Cover
          type: object
        creationTime:
          type: string
        groupId:
          format: uuid
          type: string
        id:
          format: uuid
          type: string
        isFeatured:
          type: boolean
        lastModifiedTime:
          type: string
        ownerId:
          type: string
        shared:
          type: boolean
        targetedPagesEnabled:
          type: boolean
        title:
          type: string
        type:
          enum:
            - MULTI_PAGE
            - SINGLE_PAGE
            - HOME_PAGE
          title: GuideType
          type: string
        version:
          type: integer
        visibility:
          enum:
            - PRIVATE
            - SPECIFIC
            - PORTAL
            - PUBLIC
          title: Visibility
          type: string
      title: Guide
      type: object
    GuideWithMissingAssets:
      properties:
        guide:
          properties:
            chapters:
              items:
                properties:
                  creationTime:
                    type: string
                  id:
                    format: uuid
                    type: string
                  lastModifiedTime:
                    type: string
                  ownerId:
                    type: string
                  pages:
                    items:
                      properties:
                        creationTime:
                          type: string
                        id:
                          format: uuid
                          type: string
                        lastModifiedTime:
                          type: string
                        ownerId:
                          type: string
                        state:
                          $ref: "#/components/schemas/PageState"
                        title:
                          type: string
                        visibility:
                          $ref: "#/components/schemas/Visibility"
                      title: PageOverviewHeadless
                      type: object
                    type: array
                  title:
                    type: string
                  visibility:
                    $ref: "#/components/schemas/Visibility"
                title: ChapterHeadless
                type: object
              type: array
            cover:
              description: Bynder asset data. Fields are populated when enrichment is
                available; only id is guaranteed when enrichment was skipped or
                asset was missing.
              properties:
                archive:
                  type: boolean
                brandId:
                  type: string
                copyright:
                  type: string
                dateCreated:
                  type: string
                dateModified:
                  type: string
                datePublished:
                  type: string
                description:
                  type: string
                extension:
                  items:
                    type: string
                  type: array
                fileSize:
                  type: integer
                height:
                  type: integer
                id:
                  type: string
                idHash:
                  type: string
                isPublic:
                  type: boolean
                limited:
                  type: boolean
                mediaItems:
                  items:
                    properties:
                      name:
                        type: string
                      publicUrl:
                        type: string
                      type:
                        type: string
                    type: object
                  type: array
                name:
                  type: string
                orientation:
                  type: string
                original:
                  type: string
                propertyOptions:
                  items:
                    type: string
                  type: array
                property_limitedrights:
                  type: string
                tags:
                  items:
                    type: string
                  type: array
                thumbnails:
                  properties:
                    mini:
                      type: string
                    thul:
                      type: string
                    webimage:
                      type: string
                  type: object
                transformBaseUrl:
                  type: string
                type:
                  type: string
                userCreated:
                  type: string
                videoPreviewURLs:
                  items:
                    type: string
                  type: array
                watermarked:
                  type: boolean
                width:
                  type: integer
              title: AssetDto
              type: object
            creationTime:
              type: string
            groupId:
              format: uuid
              type: string
            id:
              format: uuid
              type: string
            isFeatured:
              type: boolean
            lastModifiedTime:
              type: string
            ownerId:
              type: string
            targetedPagesEnabled:
              type: boolean
            title:
              type: string
            type:
              $ref: "#/components/schemas/GuideType"
            version:
              type: integer
            visibility:
              $ref: "#/components/schemas/Visibility"
          title: GuideHeadless
          type: object
        missingAssetIds:
          items:
            type: string
          type: array
      title: GuideWithMissingAssets
      type: object
    PageHeader:
      properties:
        asset:
          properties:
            assetExtension:
              type: string
            assetId:
              type: string
            assetName:
              type: string
            detailUrl:
              type: string
            imageUrl:
              type: string
          title: PageHeaderAsset
          type: object
        backgroundColor:
          type: string
        height:
          type: string
        isSubtitleVisible:
          type: boolean
        isTitleVisible:
          type: boolean
        isVisible:
          type: boolean
        textColorId:
          type: string
      title: PageHeader
      type: object
    PageState:
      enum:
        - DRAFT
        - PUBLISHED
      title: PageState
      type: string
    TableOfContents:
      properties:
        isVisibleInGuide:
          type: boolean
        isVisibleInPage:
          type: boolean
      title: TableOfContents
      type: object
    Visibility:
      enum:
        - PRIVATE
        - SPECIFIC
        - PORTAL
        - PUBLIC
      title: Visibility
      type: string
    GuideType:
      enum:
        - MULTI_PAGE
        - SINGLE_PAGE
        - HOME_PAGE
      title: GuideType
      type: string
```