List comparison changes

List comparison changes.

GET /api/v1/workspaces/{workspaceId}/projects/{projectId}/branch-comparisons/{id}/changes

Operation: listBranchChanges · 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.
id	path	Yes	See constraints below.
page	query	No	See constraints below.
pageSize	query	No	See constraints below.
q	query	No	See constraints below.
locale	query	No	See constraints below.
kind	query	No	See constraints below.
tag	query	No	Literal case-insensitive tag name substring, including tags attached to changed keys in base, source or target.
conflicts	query	No	See constraints below.

workspaceId

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

projectId

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

id

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

page

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

pageSize

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

q

{
  "type": "string",
  "default": ""
}

locale

{
  "type": "string",
  "default": ""
}

kind

{
  "type": "string",
  "default": ""
}

tag

{
  "type": "string",
  "maxLength": 50
}

conflicts

{
  "type": "string",
  "enum": [
    "true",
    "false"
  ],
  "default": "false"
}

Request body

No request body.

Responses

200

Success

Response headers:

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

Content type: application/json Schema reference: Changes.

Field	Type	Required	Constraints / description
items	Array of Change	Yes	—
page	integer	Yes	—
pageSize	integer	Yes	—
hasMore	boolean	Yes	—
version	integer	Yes	minimum: 1; maximum: 2147483646

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

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"
}

Related guidance

Request errors and safe retries · Troubleshooting