Branches

Lists the branches the user may see, most recently updated first by default, a page at a time. A branch is visible when the user created it and it holds no changes yet, when it changes a model they may use branches on, when it holds a draft they may edit in a branch, or when it is open to viewers and holds a model they can read.

get/api/v1/branches

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
  • Auth
    HTTP bearer

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0
pageSizeinteger

Number of results per page (1-100, integer)

Example:20
sortDirection'asc' | 'desc'

Sort direction for results

Example:desc
sortField'updatedAt' | 'createdAt' | 'name'

Field to sort results by

Example:updatedAt
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 visible branches

Changes