Search
K
CXUC

CXUC

1.0.0OAS 3.1

Read-side APIs for Bynder Brand Guidelines (CX UC module).
Serves guide, group and page queries from CXUC.

Response variants

Endpoints that accept both user JWTs and Bynder API tokens return different shapes:

  • User JWT → classic response (canEdit/canView/shared fields, Cover objects)
  • Bynder API token → headless response wrapped in a *WithMissingAssets envelope;
    HTTP 206 when one or more asset enrichment calls failed
API Base URL
  • Server 1:https://{your-bynder-domain}/

Guides

Guide endpoints

Get all guides

get
https://{your-bynder-domain}/api/1/cxuc/guides

Query Parameters

orderBystring
orderTypestring
searchTermstring
skipEnrichmentCallsstring

When present, skips asset enrichment calls

Headers

Authorizationstringrequired

Response

application/json

List of guides.

  • User JWT → classic Guides response
  • Bynder API token → GuidesWithMissingAssets (headless)
One Of
allGuidesarray[object]
Show Child Parameters
featuredGuidesarray[object]
Show Child Parameters
get/api/1/cxuc/guides
 
application/json

Get page of a guide by ID

get
https://{your-bynder-domain}/api/1/cxuc/guides/{guideId}/pages/{pageId}

Query Parameters

skipEnrichmentCallsstring

When present, skips asset enrichment calls

Path Parameters

guideIdstring(uuid)required
pageIdstring(uuid)required

Headers

Authorizationstringrequired

Response

application/json

Page.

  • User JWT → classic Page
  • Bynder API token → PageWithMissingReferences (headless)
One Of
canEditboolean
canViewboolean
creationTimestring
headerobject
Show Child Parameters
idstring(uuid)
lastModifiedTimestring
ownerIdstring
sectionsarray[object]
Show Child Parameters
sharedboolean
statestring

Allowed values:DRAFTPUBLISHED

tableOfContentsobject
Show Child Parameters
titlestring
visibilitystring

Allowed values:PRIVATESPECIFICPORTALPUBLIC

get/api/1/cxuc/guides/{guideId}/pages/{pageId}
 
application/json

Get guide by ID

get
https://{your-bynder-domain}/api/1/cxuc/guides/{id}

Query Parameters

skipEnrichmentCallsstring

When present, skips asset enrichment calls

Path Parameters

idstring(uuid)required

Headers

Authorizationstringrequired

Response

application/json

Guide.

  • User JWT / service token → classic Guide
  • Bynder API token → GuideWithMissingAssets (headless)
One Of
canEditboolean
canViewboolean
chaptersarray[object]
Show Child Parameters
coverobject
Show Child Parameters
creationTimestring
groupIdstring(uuid)
idstring(uuid)
isFeaturedboolean
lastModifiedTimestring
ownerIdstring
sharedboolean
targetedPagesEnabledboolean
titlestring
typestring

Allowed values:MULTI_PAGESINGLE_PAGEHOME_PAGE

versioninteger
visibilitystring

Allowed values:PRIVATESPECIFICPORTALPUBLIC

get/api/1/cxuc/guides/{id}
 
application/json