Site Settings

Partner-facing endpoints for listing sites and retrieving site configuration within a domain.

Operations

List sites in the specified partner domain

Request

Returns the active sites a partner is allowed to access within a domain after authorization succeeds.

Response body is a JSON array. Fields below apply to each array item.

Security

Bearer

Path

domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a

curl -i -X GET \
  https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/sites \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Array of active sites for the requested domain.

Headers

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"

Bodyapplication/json

Array [

domainstringrequired

Domain this site belongs to.

Example:"Example domain"

siteNamestringrequired

Site name.

Example:"Example Site"

]

Response