Get Branch

Get a single branch with computed status and `nextActions`. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace with the page branching entitlement.</Warning> Required scope | `branches:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
branch_idstringRequiredformat: "objectid"
Unique identifier for a Branch

Response

Branch details
idstringformat: "objectid"
siteIdstringformat: "objectid"
pageIdstringformat: "objectid"

ID of the branch page (the duplicate page on the branch).

parentPageIdstring or nullformat: "objectid"
ID of the original page the branch was created from, or null for standalone branches.
pageNamestring or null
Display name of the parent page, or the branch page title for standalone branches.
statusenum
Computed lifecycle status for a branch.
stagingDomainstring or null
Staging domain configured for branch preview publishes.
lastPublishedstring or nullformat: "date-time"
Timestamp of the last branch preview publish, if any.
reviewobject or null
Active review metadata when the branch is in review.
createdOnstringformat: "date-time"
updatedOnstringformat: "date-time"
nextActionslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error