---
title: "Guide"
url: "https://earlyaccess.developers.bynder.com/apis/cxuc-1/versions/9a8a4a13-fdd4-455b-8d92-5f16aea67949/schemas/Guide"
---

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

# Guide

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: CXUC
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
components:
  schemas:
    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
    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
```