List all branches

Retrieves a list of all branches within the specified project, including their metadata, region, and access settings.

GET /organizations/{organizationID}/projects/{projectID}/branches

Try it

List all branches

cURL

curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches \
  --header 'Authorization: Bearer <token>'

200

{
  "branches": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "region": "<string>",
      "publicAccess": true,
      "backupsEnabled": true,
      "description": "<string>",
      "parentID": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organizationID · string · required

Unique identifier of the organization containing the project

projectID · string · required

Unique identifier of the project to list branches from

Response

200

application/json

List of branches within the project

branches · object[] · required

Array of branch objects with their metadata

Show child attributes

branches. id · string · required

Unique identifier for the branch

branches. name · string · required

Human-readable name of the branch

branches. createdAt · string<date-time> · required

Timestamp when the branch was created

branches. updatedAt · string<date-time> · required

Timestamp when the branch was last updated

branches. region · string · required

Geographic region where the branch is deployed

branches. publicAccess · boolean · required

Whether the branch allows public access without authentication

branches. backupsEnabled · boolean · required

Whether the branch is in a region that supports backups

branches. description · string

Optional description of the branch purpose or contents

branches. parentID · string | null

Identifier of the parent branch if this is a derived branch, null otherwise