Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Project UUID, not a slug. Resolve a slug with GET /project/slug/{slug} using the same workspace and credentials, then pass the returned id.

Query Parameters

limit
number
merged
boolean

false lists only discarded branches, true only merged ones; omitted lists both.

deleted_by
string

A user id: the person who deleted the row; keeps only rows that match it (or, with exclude_deleted_by=true, every other row).

exclude_deleted_by
boolean

true inverts deleted_by: rows that do not match it, including rows with no value.

deleted_since
string

ISO 8601 instant; keeps only rows deleted at or after it.

deleted_until
string

ISO 8601 instant; keeps only rows deleted before it.

owner
string

A user id: the branch's owner; keeps only rows that match it (or, with exclude_owner=true, every other row).

exclude_owner
boolean

true inverts owner: rows that do not match it, including rows with no value.

parent
string

A branch id, or "master" for Base: the branch the row was created from; keeps only rows that match it (or, with exclude_parent=true, every other row).

exclude_parent
boolean

true inverts parent: rows that do not match it, including rows with no value.

tag
string

A tag, matched ignoring case; keeps only rows that match it (or, with exclude_tag=true, every other row).

exclude_tag
boolean

true inverts tag: rows that do not match it, including rows with no value.

created_since
string

ISO 8601 instant; keeps only rows created at or after it.

created_until
string

ISO 8601 instant; keeps only rows created before it.

Case-insensitive substring of the branch name; omitted or blank lists every deleted branch.

before
string

The cursor of the last row already shown; returns the page after it. Omit for the first page.

Response

200 - application/json
created_at
string
required
cursor
string
required

Pass as before to fetch the page after this row. Opaque; valid only as handed out.

deleted_at
string
required

When the branch was archived: the merge time for a merged branch, the delete time for a discarded one.

deleted_by_id
string | null
required

Who deleted a discarded branch. Null for a merged branch: the merge does not record its actor on the row.

id
string
required
labels
object[]
required
merged_at
string | null
required

Set when a merge archived the branch; null when it was discarded through the delete endpoint.

name
string
required
number
number
required

Project-scoped branch number.

owner_id
string | null
required
parent_id
string | null
required
parent_name
string | null
required

Name of the parent branch; null when the parent is Base.