Skip to content

Get operational site settings by domain and site name

Request

Returns the operational site settings 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/operational' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Operational site settings 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"
defaultBillingstring

Default billing type used when booking or invoicing.

Example:"Example defaultBilling"
defaultPrioritystring

Default appointment priority.

Example:"Example defaultPriority"
appendStudyDescriptionboolean

Whether to append the study description in downstream outputs where applicable.

Example:true
patientDobRequiredboolean

Whether date of birth is required for patients at this site.

Example:true
patientSexRequiredboolean

Whether patient sex is required for patients at this site.

Example:true
lastModifiedDateTimestring, (date-time)

When the site settings were last updated.

Example:"2020-01-01T00:00:00Z"
lastModifiedBystring

Who last updated the site settings.

Example:"Example lastModifiedBy"
Response
{
  "domain": "acme",
  "siteName": "Central Clinic",
  "companyName": "ACME Radiology",
  "timeZone": "Australia/Sydney",
  "defaultBilling": "bulk",
  "defaultPriority": "Routine",
  "appendStudyDescription": true,
  "patientDobRequired": true,
  "patientSexRequired": true,
  "lastModifiedDateTime": "2025-01-10T02:03:04Z",
  "lastModifiedBy": "jsmith"
}