Get site settings summary by domain and site name

Request

Returns the site settings summary view for a specific site when the caller is authorized for the requested domain and site.

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

siteNamestringrequired

Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.

Example:Example Site

Headers

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/Example Site' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Site settings summary view for the requested domain and site.

Headers

X-Correlation-Idstring

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

Example:"4b7f0a91b4f54f2a"

Bodyapplication/json

domainstringrequired

Domain this site belongs to.

Example:"Example domain"

siteNamestringrequired

Site name.

Example:"Example Site"

companyNamestringrequired

Company name associated with the site.

Example:"Example Name"

siteTimeZoneIdstring

Example:"123"

timeZonestring

IANA or platform timezone identifier used by the site.

Example:"Example timeZone"

Response

{
  "domain": "acme",
  "siteName": "Central Clinic",
  "companyName": "ACME Radiology",
  "timeZone": "Australia/Sydney"
}