---
title: "Get all guides"
url: "https://earlyaccess.developers.bynder.com/apis/cxuc-1/versions/9a8a4a13-fdd4-455b-8d92-5f16aea67949/operations/getGuidesApi"
---

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

# Get all guides

`GET` `/api/1/cxuc/guides`

Operation ID: `getGuidesApi`

## Query parameters

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

## Header parameters

- `Authorization` (string, required)

## Responses

- `200` - List of guides. - User JWT → classic `Guides` response - Bynder API token → `GuidesWithMissingAssets` (headless)
- `206` - Guides with some missing asset enrichments (Bynder API token only)
- `401` - Unauthorized
- `403` - Forbidden

## 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:
    get:
      operationId: getGuidesApi
      parameters:
        - in: query
          name: orderBy
          required: false
          schema:
            type: string
        - in: query
          name: orderType
          required: false
          schema:
            type: string
        - in: query
          name: searchTerm
          required: false
          schema:
            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/Guides"
                  - $ref: "#/components/schemas/GuidesWithMissingAssets"
          description: |
            List of guides.
            - User JWT → classic `Guides` response
            - Bynder API token → `GuidesWithMissingAssets` (headless)
        "206":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GuidesWithMissingAssets"
          description: Guides with some missing asset enrichments (Bynder API token only)
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
      summary: Get all guides
      tags:
        - Guides
components:
  schemas:
    Guides:
      properties:
        allGuides:
          items:
            properties:
              canEdit:
                type: boolean
              canView:
                type: boolean
              cover:
                $ref: "#/components/schemas/Cover"
              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:
                $ref: "#/components/schemas/GuideType"
              version:
                type: integer
              visibility:
                $ref: "#/components/schemas/Visibility"
            title: GuideOverview
            type: object
          type: array
        featuredGuides:
          items:
            $ref: "#/components/schemas/GuideOverview"
          type: array
      title: Guides
      type: object
    GuidesWithMissingAssets:
      properties:
        guides:
          properties:
            allGuides:
              items:
                properties:
                  cover:
                    $ref: "#/components/schemas/AssetDto"
                  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: GuideOverviewHeadless
                type: object
              type: array
            featuredGuides:
              items:
                $ref: "#/components/schemas/GuideOverviewHeadless"
              type: array
          title: GuidesHeadless
          type: object
        missingAssetIds:
          items:
            type: string
          type: array
      title: GuidesWithMissingAssets
      type: object
    Cover:
      properties:
        assetId:
          type: string
        assetName:
          type: string
        detailUrl:
          type: string
        imageUrl:
          type: string
      title: Cover
      type: object
    GuideType:
      enum:
        - MULTI_PAGE
        - SINGLE_PAGE
        - HOME_PAGE
      title: GuideType
      type: string
    Visibility:
      enum:
        - PRIVATE
        - SPECIFIC
        - PORTAL
        - PUBLIC
      title: Visibility
      type: string
    GuideOverview:
      properties:
        canEdit:
          type: boolean
        canView:
          type: boolean
        cover:
          $ref: "#/components/schemas/Cover"
        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:
          $ref: "#/components/schemas/GuideType"
        version:
          type: integer
        visibility:
          $ref: "#/components/schemas/Visibility"
      title: GuideOverview
      type: object
    AssetDto:
      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
    GuideOverviewHeadless:
      properties:
        cover:
          $ref: "#/components/schemas/AssetDto"
        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: GuideOverviewHeadless
      type: object
```