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

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

Get staff skill grid for a site

Request

Returns the staff skills grid, exam mappings, and comments for the specified domain and site when authorized.

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/staff-skills' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Staff skills grid and related metadata for the requested domain and site.

Bodyapplication/json
examKeysArray of strings

Ordered list of exam keys used as columns in the grid.

Example: ["Example examKeys"]
examDisplayobject

Map of exam key to display label.

headerCommentsobject

Map of exam key to optional header comment/marker metadata.

employeesArray of objects(EmployeeSkillResponse)

List of staff rows in the grid.

examSitesobject

Map of exam key to list of sites where the exam is available.

skToExamCodeIdobject

Map of internal exam key to examCodeId.

examCodeSiteKeysobject

Nested map of examCodeId to site name to internal key.

Response
application/json
{
  "examKeys": [
    "Example examKeys"
  ],
  "examDisplay": {
    "property1": "Example examDisplay",
    "property2": "Example examDisplay"
  },
  "headerComments": {
    "property1": { … },
    "property2": { … }
  },
  "employees": [
    { … }
  ],
  "examSites": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "skToExamCodeId": {
    "property1": "123",
    "property2": "123"
  },
  "examCodeSiteKeys": {
    "property1": { … },
    "property2": { … }
  }
}

Appointments

Partner-facing endpoints for retrieving appointments within a domain.

Operations