Skip to main content
GET
/
projects
/
{id}
/
branches
List branches for a project
curl --request GET \
  --url https://api.specular.dev/projects/{id}/branches \
  --header 'Authorization: Bearer <token>'
{
  "branches": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "name": "<string>",
      "state": "idle",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "openApiSpec": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication with API key (format: Bearer sk_xxx)

Path Parameters

id
string
required

Project ID

Query Parameters

limit
integer
default:20

Maximum number of branches to return (1-100)

Required range: 1 <= x <= 100
offset
integer
default:0

Number of branches to skip

Required range: x >= 0

Response

List of branches

List of branches

branches
object[]
total
integer

Total number of branches

limit
integer

Maximum number of branches returned

offset
integer

Number of branches skipped