Skip to main content
POST
Preview Deployment Changes

Authentication and permissions

Token requirements: User-based token (OAuth). Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
  • User: workspace comparison: Requires permission to author promotions from the source workspace and stage promotions into the target workspace, with an active link between them. Every comparison and document read checks both permissions.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
sourceTeamId
string
required
targetTeamId
string
required
filters
filters · object

Values within a filter are ORed; separate filters are ANDed.

pageSize
integer<int32>

Defaults to 50; maximum 100.

pageToken
string

Requires the same workspaces and filters as the preceding page.

resourceKeys
TeamConfigResourceKey · object[]

Read current documents for 1–20 unique keys, in request order. Cannot be combined with filters, page_size, or page_token.

Response

200 - application/json

Success

data
TeamConfigDiffItem · object[]
nextPageToken
string
matchingCount
integer<int32>

Number of matching rows, including required unchanged context.