List branch operations

List branch operations.

GET /api/v1/workspaces/{workspaceId}/projects/{projectId}/branch-jobs

Operation: listBranchJobs · Download OpenAPI

Access

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Name	Location	Required	Description
`workspaceId`	path	Yes	See constraints below.
`projectId`	path	Yes	See constraints below.
`page`	query	No	See constraints below.
`pageSize`	query	No	See constraints below.

workspaceId

{
  "type": "string",
  "format": "uuid"
}

projectId

{
  "type": "string",
  "format": "uuid"
}

page

{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

pageSize

{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 25
}

Request body

No request body.

Responses

200

Success

Response headers:

{
  "Cache-Control": {
    "schema": {
      "type": "string",
      "const": "no-store"
    }
  }
}

Content type: application/json Schema reference: Jobs.

Field	Type	Required	Constraints / description
`items`	Array of BranchJob	Yes	—
`page`	integer	Yes	—
`pageSize`	integer	Yes	—
`hasMore`	boolean	Yes	—

{
  "$ref": "#/components/schemas/Jobs"
}

400

Invalid request.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

401

Sign in required.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

403

Insufficient current workspace role.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

404

Resource unavailable in this scope.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

409

Version conflict, stale preview or content invariant.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

429

Request limit exceeded.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

503

Service unavailable; success is not implied.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	`unauthorized`, `forbidden`, `invalid_request`, `not_found`, `conflict`, `rate_limited`, `unavailable`	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—

{
  "$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting