# API

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

Version: v1

## Servers

Relative to the current host
```
/
```

## Security

### Bearer

JWT bearer token

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[API](https://partners.qubs.io/_bundle/openapi.yaml)

## Site Settings

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

### List sites in the specified partner domain

 - [GET /integrations/v1/{domain}/sites](https://partners.qubs.io/openapi/site-settings/integrations_listsites.md): Returns the active sites a partner is allowed to access within a domain after authorization succeeds.

### Get site settings summary by domain and site name

 - [GET /integrations/v1/{domain}/sites/{siteName}](https://partners.qubs.io/openapi/site-settings/integrations_getsitesettings_summary.md): Returns the site settings summary view for a specific site when the caller is authorized for the requested domain and site.

### Get operational site settings by domain and site name

 - [GET /integrations/v1/{domain}/sites/{siteName}/operational](https://partners.qubs.io/openapi/site-settings/integrations_getsitesettings_operational.md): Returns the operational site settings view for a specific site when the caller is authorized for the requested domain and site.

## Exam Codes

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

### List exam codes for a site

 - [GET /integrations/v1/{domain}/sites/{siteName}/exam-codes](https://partners.qubs.io/openapi/exam-codes/integrations_listexamcodes.md): Returns exam codes for the specified domain and site when the caller is authorized.

## Staff Skills

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

### Get staff skill grid for a site

 - [GET /integrations/v1/{domain}/sites/{siteName}/staff-skills](https://partners.qubs.io/openapi/staff-skills/integrations_getstaffskills.md): Returns the staff skills grid, exam mappings, and comments for the specified domain and site when authorized.

## Appointments

Partner-facing endpoints for retrieving appointments within a domain.

### List operational appointments by status

 - [GET /integrations/v1/{domain}/appointments/operational/by-status/{status}](https://partners.qubs.io/openapi/appointments/integrations_listappointmentsbystatus_operational.md): Returns the operational appointment view filtered by status when the caller is authorized. Supports cursor-based pagination via pageSize and nextToken.

### Get operational appointment by domain and appointment id

 - [GET /integrations/v1/{domain}/appointments/operational/{appointmentId}](https://partners.qubs.io/openapi/appointments/integrations_getappointment_operational.md): Returns the operational appointment view for the specified domain and appointment id when the caller is authorized.

### List operational appointments for a domain

 - [GET /integrations/v1/{domain}/appointments/operational](https://partners.qubs.io/openapi/appointments/integrations_listappointments_operational.md): Returns the operational appointment view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take.

### List appointment summaries by status

 - [GET /integrations/v1/{domain}/appointments/by-status/{status}](https://partners.qubs.io/openapi/appointments/integrations_listappointmentsbystatus_summary.md): Returns the appointment summary view filtered by status when the caller is authorized. Supports cursor-based pagination via pageSize and nextToken.

### Get appointment summary by domain and appointment id

 - [GET /integrations/v1/{domain}/appointments/{appointmentId}](https://partners.qubs.io/openapi/appointments/integrations_getappointment_summary.md): Returns the appointment summary view for the specified domain and appointment id when the caller is authorized.

### List appointment summaries for a domain

 - [GET /integrations/v1/{domain}/appointments](https://partners.qubs.io/openapi/appointments/integrations_listappointments_summary.md): Returns the appointment summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take.

## Attachments

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

### List attachments for an appointment

 - [GET /integrations/v1/{domain}/appointments/{appointmentId}/attachments](https://partners.qubs.io/openapi/attachments/integrations_listappointmentattachments.md): Returns appointment attachments (e.g. referrals, worksheets) and a short-lived presigned URL for each attachment when available.

### Get a single attachment for an appointment

 - [GET /integrations/v1/{domain}/appointments/{appointmentId}/attachments/{attachmentGuid}](https://partners.qubs.io/openapi/attachments/integrations_getappointmentattachment.md): Returns a single appointment attachment and a short-lived presigned URL when available.

## Reporting

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

### List pending reporting appointments

 - [GET /integrations/v1/{domain}/reporting/appointments/pending](https://partners.qubs.io/openapi/reporting/integrations_listpendingreportingappointments.md): Returns the clinical appointment view for appointments in the PENDING REPORTING status. Supports cursor-based pagination via pageSize and nextToken.