Branches

List deleted branches

One page of branches created after this update was deployed and then soft-deleted, whether discarded through the delete endpoint (merged_at null) or archived by a merge (merged_at set), newest archive first. A page holds at most 200 rows (pass a smaller limit to take fewer); to continue, pass the cursor of the last row shown as before. search keeps only names containing the text, ignoring case. Every merge archives its branch, so pass merged=false to list only discarded branches, or merged=true only merged ones. Each row is a candidate for the restore preview and the restore endpoint.

GET

/

project

/

{projectId}

/

branch

/

archived

List deleted branches

curl --request GET \
  --url https://backend.branch.flowengineering.com/project/{projectId}/branch/archived \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/branch/archived"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/branch/archived', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "cursor": "<string>",
    "deleted_at": "<string>",
    "deleted_by_id": "<string>",
    "id": "<string>",
    "merged_at": "<string>",
    "name": "<string>",
    "number": 123,
    "parent_id": "<string>",
    "parent_name": "<string>"
  }
]

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.

search

string

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

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

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.

parent_id

string | null

required

parent_name

string | null

required

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

List deleted branches

curl --request GET \
  --url https://backend.branch.flowengineering.com/project/{projectId}/branch/archived \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/branch/archived"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/branch/archived', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "cursor": "<string>",
    "deleted_at": "<string>",
    "deleted_by_id": "<string>",
    "id": "<string>",
    "merged_at": "<string>",
    "name": "<string>",
    "number": 123,
    "parent_id": "<string>",
    "parent_name": "<string>"
  }
]