Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Branches

List branches

List all branches of the current project.

Requires the Branching feature to be enabled on the account.

get/projects/{project_id}/branches

Path parameters

project_idstring required

Project ID

Query parameters

pageinteger

Page number

per_pageinteger

Limit on the number of objects to be returned, between 1 and 100. 25 by default

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

base_project_idstring
branch_project_idstring
namestring
basestring nullable

Name of the base branch this branch was created from. Only present for branches created with the newer branching system.

created_atstring date-time
updated_atstring date-time
merged_atstring date-time
state'creating_branch' | 'merging_branch' | 'syncing_branch' | 'merged' | 'success' | 'branch_error' | 'merge_conflict'
child_branchesstring[]

Example response

[
  {
    "name": "new-branch",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z",
    "merged_at": "2015-01-28T09:52:53Z",
    "merged_by": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "created_by": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "state": "success",
    "child_branches": [
      "feature_2",
      "feature_3"
    ]
  }
]