Skip to content

QUBS Integrations API (v1)

Partner-facing API providing read-only access to selected QUBS configuration and scheduling data for integration purposes.

Authentication is via a bearer JWT in the Authorization header. Authorization is domain-scoped; all requests include a {domain} path parameter.

Errors are returned as RFC7807 Problem Details (application/problem+json).

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://partners.qubs.io/_mock/openapi/
Relative to the current host
https://partners.qubs.io/

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.

Security
Bearer
Path
domainstringrequired

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

Example: acme
curl -i -X GET \
  https://partners.qubs.io/_mock/openapi/integrations/v1/acme/sites \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of active sites for the requested domain.

Bodyapplication/jsonArray [
domainstringrequired

Domain this site belongs to.

Example: "Example domain"
siteNamestringrequired

Site name.

Example: "Example Site"
]
Response
application/json
[
  {
    "domain": "Example domain",
    "siteName": "Example Site"
  }
]

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. 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.

Example: Example Site
curl -i -X GET \
  'https://partners.qubs.io/_mock/openapi/integrations/v1/acme/sites/Example Site' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site settings summary view for the requested domain and site.

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

IANA or platform timezone identifier used by the site.

Example: "Example timeZone"
Response
application/json
{
  "domain": "Example domain",
  "siteName": "Example Site",
  "companyName": "Example Name",
  "timeZone": "Example timeZone"
}

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. 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.

Example: Example Site
curl -i -X GET \
  'https://partners.qubs.io/_mock/openapi/integrations/v1/acme/sites/Example Site/operational' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Operational site settings view for the requested domain and site.

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"
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
application/json
{
  "domain": "Example domain",
  "siteName": "Example Site",
  "companyName": "Example Name",
  "timeZone": "Example timeZone",
  "defaultBilling": "Example defaultBilling",
  "defaultPriority": "Example defaultPriority",
  "appendStudyDescription": true,
  "patientDobRequired": true,
  "patientSexRequired": true,
  "lastModifiedDateTime": "2020-01-01T00:00:00Z",
  "lastModifiedBy": "Example lastModifiedBy"
}

Exam Codes

Partner-facing endpoints for retrieving exam code configuration for a site within a domain.

Operations

Staff Skills

Partner-facing endpoints for retrieving the staff skill grid and related metadata for a site within a domain.

Operations

Appointments

Partner-facing endpoints for retrieving appointments within a domain.

Operations

Attachments

Partner-facing endpoints for retrieving appointment attachments and generating short-lived presigned URLs.

Operations

Comments

Partner-facing endpoints for retrieving appointment and patient comments/alerts associated with an appointment.

Operations

Patients

Partner-facing endpoints for retrieving patients within a domain.

Operations

Reporting

Partner-facing endpoints for retrieving appointments that are pending reporting.

Operations