OMomniapp
Branches

Get branch

Changed on

The branch and its parts as the user sees them: each model with changes, with the drafts on that model, and each draft on a model without changes, with whether the user may merge it and the reason when not. Parts the user cannot see are left out. A live branch the user cannot see is refused.

get/api/v1/branches/{branchId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/branches/{branchId}
  • Auth
    HTTP bearer

Path parameters

branchIdstring uuid required

Branch ID: the org-wide branch, as orgBranchId on branch responses. A model-level branch ID is not accepted.

Query parameters

userIdstring uuid

User ID of the user to act as, as userId on other endpoints. Required with an organization API key; a user-scoped key may only name its own user.

Response

The branch

successboolean required

Whether the operation succeeded

Changes