> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List exposure days

> List each person's exposure on each Europe/London day of a window, against their effective limit
that day: the breach list and the trend on a person's page.

A row is one person and one day that has records in this organisation, or whose total or rolling
7-day total reaches amber. It carries the day's total and the week's total (that day and the 6 before it), the
effective daily and weekly amber and red (as `GET /v3/orgs/{org_id}/exposure-limits/{user_id}`
resolves them), the layer that set red, and a band for each: `green` below amber, `amber` at or
above amber (near-limit) and `red` at or above red (breach). Rows are newest day first, then by
person. The resource has no includes, so `included` is absent.

A person's totals and bands count their records in every organisation, because a limit applies to
their whole dose. A day whose records are all in another organisation is listed only when it
reaches amber. No organisation, record or split by organisation is returned: another
organisation's records show only as part of a total.

Only the people the caller holds `exposure-limits:view` on are included: a HAVS Operator themselves,
a manager the people their management relationships reach, and Occupational Health everyone in the
organisation. A caller who holds it on nobody gets an empty list. Former members are included, so
someone who has left keeps their past days and breaches.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v3/orgs/{org_id}/exposure-days
openapi: 3.1.0
info:
  contact:
    email: support@ctrl-hub.com
    name: Ctrl Hub
    url: https://www.ctrl-hub.com
  description: >
    Ctrl Hub is the all-in-one platform for high-risk industries like utilities,
    construction, infrastructure, and renewables. We help teams manage
    everything from risk assessments and HAVS exposure to vehicle and equipment
    checks, with a guaranteed minimum of 200% ROI.
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  summary: An API for managing your compliance and risk posture
  termsOfService: https://www.ctrl-hub.com/terms-conditions
  title: Ctrl Hub
  version: 1.0.0
servers:
  - description: Production
    url: https://api.ctrl-hub.com
  - description: Staging
    url: https://api.ctrl-hub.dev
  - description: Development
    url: https://api.ctrl-hub.run
security: []
tags:
  - description: |
      Actions are follow-ups assigned to users and teams, produced manually or
      by domain producers such as the data-capture workflow runner.
    name: Actions
  - description: |
      Audit events are the events that are logged by the system.
    name: Audit Events
  - description: |
      View the platform's health and availability.
    name: Status
  - description: >
      User-owned dashboards composed of cards on a fixed-slot bento layout.
      Cards come from a per-domain registry; the API stores their config as
      opaque JSON.
    name: Dashboards
  - description: >
      Copies of a mobile device's local database, sent by the operative on
      request so that people

      in their organisation can recover work that never reached the server. Kept
      for 30 days, and

      visible to people granted `device-backups:view` in the organisation each
      is filed against.
    name: Device Backups
  - description: >
      A record of documents the platform generated and handed over, retained as
      evidence of what

      was issued. `subject_type` says what kind of records an export covers, and
      it is what decides

      how the request is authorised: there is no export permission of its own,
      so if you can see the

      records you can export them.
    name: Exports
  - description: >
      Scheduled delivery of a saved query's results, as a CSV attachment or a
      summary email. Every run is retained with the file it sent, so what a
      recipient received stays retrievable. A report runs as the person who
      created it, under their own access.
    name: Reports
  - description: >
      Performance standards the platform defines, such as the gas Guaranteed
      Standards of Performance 3 and 13, and how an organisation's forms answer
      them. An organisation maps its form fields to a standard's inputs, and the
      mapping generates a saved query that reads the answers.
    name: Standards
  - description: |
      Manage appointments for work to be carried out with your customers
    name: Customer Appointments
  - description: |
      Manage interactions you have with your customers
    name: Customer Interactions
  - description: |
      Manage accounts for your customers
    name: Customer Accounts and Contacts
  - description: >
      Competency: the assessments, training items, inductions and registrations
      an

      organisation requires, and the specifications that combine them.
    name: Qualifications
  - description: |
      Workflows allow you to automate your processes.
    name: Workflows
  - description: |
      Manage documents
    name: Documents
  - description: |
      Manage documents
    name: Folders
  - description: |
      Manage documents
    name: Document Reviews
  - description: |
      Manage feature configurations for an organisation.
    name: Feature Configurations
  - description: |
      Equipment are the physical assets that an organisation manages.
    name: Equipment
  - description: >
      Exposure limits: an organisation's thresholds for each exposure type,
      stricter than the HSE

      values, and the limit in force for a person on a date.
    name: Exposure Limits
  - description: |
      The central cost register: time-versioned rate codes for material, labour,
      contractor and miscellaneous spend, used to cost work against the job
      hierarchy.
    name: Costs
  - description: >
      Locations are places an organisation manages, optionally classified by a
      location type.
    name: Locations
  - description: >
      Bulk loads of locations from an uploaded CSV. An import matches rows on
      the organisation's own

      `reference`, so re-importing a corrected file updates what is already
      there rather than

      doubling the population, and the import record is the audit trail for the
      whole load: the bulk

      write path deliberately emits no per-row events.
    name: Location Imports
  - description: |
      Manage your forms and their schemas
    name: Forms, Schemas and Categories
  - description: |
      Create and view form submissions
    name: Submissions
  - description: >
      Recurring reminders to fill in a form, for the people, teams and job roles
      each names. A form can have several. Only the organisation that owns a
      form sets its reminders.
    name: Form Reminders
  - description: |
      View the roles available in the system.
    name: IAM Roles
  - description: >
      IAM role groups can be assigned to principals to manage authorisation
      centrally.
    name: IAM Role Groups
  - description: |
      Manage service accounts which can access the API programmatically.
    name: Service Accounts
  - description: |
      Manage bridges between organisations.
    name: Bridges
  - description: |
      Manage settings for an organisation.
    name: Settings
  - description: |
      Manage teams within an organisation.
    name: Teams
  - description: >
      Manage who manages whom within an organisation, and the manager roles that
      say what a manager may do for their people.
    name: Management
  - description: |
      Manage job roles within an organisation.
    name: Job Roles
  - description: |
      Manage users and accounts.
    name: Users
  - description: |
      Invite and manage invitations to organisations.
    name: Invitations
  - description: >
      IAM grants are the asignment of roles or permissions to principals to
      manage resource access.
    name: IAM Grants
  - description: |
      View the permissions available in the system.
    name: IAM Permissions
  - description: |
      SSO providers are the identity providers for an organisation.
    name: SSO Providers
  - description: |
      Whoami returns information about the currently authenticated principal.
    name: Whoami
  - description: |
      Your personal inbox. A notification is the thing you receive: an envelope
      that carries what happened to one or more channels. Email is one of those
      channels, the inbox is another, and this is where the ones delivered to
      your inbox are listed, read, saved and archived.
    name: Notifications
  - description: |
      Manage your images
    name: Images
  - description: >
      AI agent personas that synthesise data into role-specific intelligent
      briefings.
    name: Agents
  - description: |
      Briefings generated by AI agents, including reasoning traces.
    name: Agent Briefings
  - description: >
      Feedback a console user sends to Ctrl Hub from any page. Only Ctrl Hub
      staff read it, on the

      Management API.
    name: User Feedback
  - description: >
      Notices an organisation sends to its own people and its contractors'
      people, who

      acknowledge that they have read and understood them. Replaces v2's
      bulletins.
    name: Briefings
  - description: >
      Things an organisation has that expire or renew, such as insurance,
      accreditations, domains,

      certificates and contracts, in the organisation's own categories. Their
      recipients are told

      ahead of time, and evidence is attached to each period.
    name: Reminders
  - description: >
      What falls due in an organisation between two dates, drawn from reminders,
      documents,

      competency records and work permits.
    name: Calendar
  - description: >
      The UK bank holidays of each nation, as gov.uk publishes them. Form
      reminders skip the

      bank holidays of the nation an organisation keeps.
    name: Bank Holidays
  - description: >
      Organisations are the center point for most resources in the platform.
      Most other endpoints are subresources of an organisation.
    name: Organisations
  - description: |
      Permits managements, integrated with street manager.
    name: Permits
  - description: |
      Projects manage your work and governance.
    name: Projects
  - description: >
      Import templates allow users to save and reuse their CSV importer
      configuration as named templates.
    name: Import Templates
  - description: |
      Properties are the physical locations.
    name: Properties
  - description: |
      Search across schemes, work orders, and operations.
    name: Search
  - description: |
      Provides the API specification in JSON and YAML formats
    name: Specifications
  - description: |
      Streets are the physical roads.
    name: Streets
  - description: |
      Integration with street manager
    name: Street Manager
  - description: |
      Vehicles are the physical vehicles that an organisation manages.
    name: Vehicles
  - description: >
      Scheme contracts (also known as regions) group schemes allocated from the
      network to a contractor.
    name: Scheme Contracts
  - description: >
      Scheme shares allow you to share your schemes with other organisations
      across bridges.
    name: Scheme Shares
  - description: |
      Schemes are large programmes of work
    name: Schemes
  - description: >
      A Construction Phase Plan is the Principal Contractor's plan for managing
      health and safety

      on a scheme, under CDM 2015. Its risks are control measures written
      against the hazards on

      the scheme's Pre-Construction Information. Each section is owned by one
      duty-holder role.
    name: Construction Phase Plans
  - description: >
      A Pre-Construction Information pack is the Client's information about a
      scheme under CDM

      2015, with its site hazards. A scheme has at most one. Each section is
      owned by one

      duty-holder role, and only that role can write it.
    name: Pre-Construction Information
  - description: >
      Site attendances record who was on site and when, whether or not they hold
      an account.

      There is no daily register resource: a day's register and who is currently
      on site are

      both queries over the attendances themselves.
    name: Site Attendances
  - description: |
      Work orders the component parts of a scheme.
    name: Work Orders
  - description: |
      Operations are the work to be carried out within work orders.
    name: Operations
externalDocs:
  description: More documentation and resources
  url: https://docs.ctrl-hub.com
paths:
  /v3/orgs/{org_id}/exposure-days:
    get:
      tags:
        - Exposure Limits
      summary: List exposure days
      description: >
        List each person's exposure on each Europe/London day of a window,
        against their effective limit

        that day: the breach list and the trend on a person's page.


        A row is one person and one day that has records in this organisation,
        or whose total or rolling

        7-day total reaches amber. It carries the day's total and the week's
        total (that day and the 6 before it), the

        effective daily and weekly amber and red (as `GET
        /v3/orgs/{org_id}/exposure-limits/{user_id}`

        resolves them), the layer that set red, and a band for each: `green`
        below amber, `amber` at or

        above amber (near-limit) and `red` at or above red (breach). Rows are
        newest day first, then by

        person. The resource has no includes, so `included` is absent.


        A person's totals and bands count their records in every organisation,
        because a limit applies to

        their whole dose. A day whose records are all in another organisation is
        listed only when it

        reaches amber. No organisation, record or split by organisation is
        returned: another

        organisation's records show only as part of a total.


        Only the people the caller holds `exposure-limits:view` on are included:
        a HAVS Operator themselves,

        a manager the people their management relationships reach, and
        Occupational Health everyone in the

        organisation. A caller who holds it on nobody gets an empty list. Former
        members are included, so

        someone who has left keeps their past days and breaches.
      operationId: ListExposureDays
      parameters:
        - $ref: '#/components/parameters/org_id'
        - $ref: '#/components/parameters/exposure_type'
        - $ref: '#/components/parameters/exposure_days_filter'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          $ref: '#/components/responses/ListExposureDays'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - Session: []
        - OAuth2: []
        - Cookie: []
components:
  parameters:
    org_id:
      name: org_id
      in: path
      required: true
      description: The unique identifier for the organisation.
      schema:
        type: string
        format: uuid
      example: c000c344-8847-47da-a091-32e75902d3b1
    exposure_type:
      name: exposure_type
      in: query
      required: true
      description: The exposure type to resolve the limit for.
      schema:
        $ref: '#/components/schemas/ExposureType'
      example: havs
    exposure_days_filter:
      name: filter
      in: query
      description: >
        Selects the days and people. Required, because it carries the window.


        - `ge(date,YYYY-MM-DD)`: **Required.** The window's first Europe/London
        day.

        - `le(date,YYYY-MM-DD)`: **Required.** The window's last day. A window
        spans at most 93 days.

        - `eq(subject,xxx)` or `in(subject,[xxx,yyy])`: only these people.

        - `eq(band,red)` or `in(band,[amber,red])`: only days in these daily
        bands. The breach list is
          `in(band,[amber,red])`.
        - `eq(weekly_band,red)` or `in(weekly_band,[amber,red])`: only days in
        these weekly bands.


        Terms are comma separated, or wrapped in `and(...)`, and combine with
        AND. Each field other than

        `date` may appear in one term. An `or(...)`, a repeated term, text after
        a term, any other term and a

        term that does not parse are refused with a 400 rather than ignored.


        For more information on using named filters, see [the
        docs](https://docs.ctrl-hub.com/api-reference/features#filtering)
      required: true
      schema:
        type: string
        minLength: 1
        example: and(ge(date,2026-11-01),le(date,2026-11-30),in(band,[amber,red]))
    limit:
      name: limit
      in: query
      description: Limit the number of resources returned by the API, at most 1000
      required: false
      schema:
        type: integer
        format: int64
        minimum: 1
        maximum: 1000
        default: 100
    offset:
      name: offset
      in: query
      description: Offset the resources returned by the API
      required: false
      schema:
        type: integer
        format: int64
        minimum: 0
        default: 0
    page:
      name: page
      in: query
      description: >
        JSON:API pagination, as `page[limit]` and `page[offset]`. The same as
        the top-level `limit` and `offset` parameters; when both forms are sent,
        `page[...]` wins.
      required: false
      style: deepObject
      explode: true
      schema:
        type: object
        additionalProperties: false
        properties:
          limit:
            type: integer
            format: int64
            minimum: 1
            maximum: 1000
            description: >-
              Limit the number of resources returned by the API, at most 1000.
              Defaults to the operation's `limit` default.
          offset:
            type: integer
            format: int64
            minimum: 0
            description: Offset the resources returned by the API. Defaults to 0.
  responses:
    ListExposureDays:
      description: Get a list of exposure days.
      headers:
        Content-Type:
          $ref: '#/components/headers/content-type'
        Content-Length:
          $ref: '#/components/headers/content-length'
        X-Request-ID:
          $ref: '#/components/headers/x-request-id'
      content:
        application/vnd.api+json:
          schema:
            allOf:
              - type: object
                required:
                  - data
                properties:
                  data:
                    title: A list of exposure days
                    type: array
                    items:
                      $ref: '#/components/schemas/ExposureDay'
              - $ref: '#/components/schemas/DocumentMeta'
              - $ref: '#/components/schemas/JSONAPI'
    BadRequest:
      description: >
        There was an error with the request - this could be due to an invalid
        body, query parameters,

        or headers that were sent to the API.
      headers:
        Content-Type:
          $ref: '#/components/headers/content-type'
        Content-Length:
          $ref: '#/components/headers/content-length'
        X-Request-ID:
          $ref: '#/components/headers/x-request-id'
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/Error'
          example:
            id: 98ca4a78-b66f-4234-9719-aaf832ee6669
            status: '400'
            title: A validation error was encountered
            source:
              parameter: include
            meta:
              resource: wrong_value
    Unauthorised:
      description: Authentication failed
      headers:
        Content-Type:
          $ref: '#/components/headers/content-type'
        Content-Length:
          $ref: '#/components/headers/content-length'
        X-Request-ID:
          $ref: '#/components/headers/x-request-id'
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/Error'
          example:
            id: 05fc9c8d-73b9-4697-9337-57f7a567a48f
            status: '401'
            title: You are not authorised to access this resource
            detail: In order to access this resource, you need the 'admin' role.
            code: AUTH.001
    NotFound:
      description: The requested resource could not be found
      headers:
        Content-Type:
          $ref: '#/components/headers/content-type'
        Content-Length:
          $ref: '#/components/headers/content-length'
        X-Request-ID:
          $ref: '#/components/headers/x-request-id'
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/Error'
          example:
            id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f
            status: '404'
            title: Resource not found
            detail: The requested resource could not be found or does not exist.
            code: NOT_FOUND.001
    InternalServerError:
      description: There was a problem handling the request on the server side
      headers:
        Content-Type:
          $ref: '#/components/headers/content-type'
        Content-Length:
          $ref: '#/components/headers/content-length'
        X-Request-ID:
          $ref: '#/components/headers/x-request-id'
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/Error'
          example:
            id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5
            status: '500'
            title: Internal Server Error
            detail: An unexpected error occurred on the server.
  schemas:
    ExposureType:
      type: string
      description: >
        The type of exposure a limit applies to. `havs` (hand-arm vibration, in
        points) is the only type.
      enum:
        - havs
      examples:
        - havs
    ExposureDay:
      type: object
      description: >
        One person's exposure on one Europe/London day, and their effective
        limit that day, computed when

        asked for. A limit applies to the person's whole dose, so the totals
        count their records in every

        organisation. A day is listed when they have records in this
        organisation that day, or when its

        day or week reaches amber. Another organisation's records show only as
        part of a total.
      required:
        - id
        - type
        - attributes
        - relationships
      properties:
        id:
          type: string
          description: >
            The person's user id, the exposure type and the date, joined by
            colons. It is unique within

            the organisation in the path: the same person and day in another
            organisation has the same id

            and other totals. Clients should read `subject`, `exposure_type` and
            `date` rather than parse

            the id.
          example: 3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a:havs:2026-11-11
        type:
          type: string
          const: exposure-days
        attributes:
          $ref: '#/components/schemas/ExposureDayAttributes'
        relationships:
          $ref: '#/components/schemas/ExposureDayRelationships'
    DocumentMeta:
      type: object
      description: Document level meta about the resources on the server in list endpoints.
      required:
        - meta
      properties:
        meta:
          type: object
          required:
            - pagination
          properties:
            features:
              $ref: '#/components/schemas/Features'
            pagination:
              $ref: '#/components/schemas/Pagination'
    JSONAPI:
      type: object
      description: JSON API response object
      required:
        - jsonapi
      properties:
        jsonapi:
          type: object
          required:
            - version
          properties:
            version:
              type: string
              description: The version of the JSON API specification
              examples:
                - '1.0'
    Error:
      type: object
      description: An error response
      properties:
        id:
          description: >-
            A unique identifier for this particular occurrence of the problem.
            If you encounter this, please provide us with the error ID and we
            can investigate it on our side.
          type: string
          format: uuid
          examples:
            - 05fc9c8d-73b9-4697-9337-57f7a567a48f
        status:
          description: >-
            The status code for the error. This might not match the HTTP status
            code if there are more that one errors to return with different
            status codes.
          type: string
          examples:
            - '401'
            - '500'
        title:
          description: A human readable title for the error.
          type: string
          examples:
            - You are not authorised to access this resource
        detail:
          description: >-
            Where there is more detail that we can provide outside of the title,
            we will provide it here.
          type: string
          examples:
            - In order to access this resource, you need the 'admin' role.
        code:
          description: >-
            A unique code for the error that may help us to diagnose the issue.
            Not all errors have codes, so this is usually empty.

            `CH.003.080` (403) means the organisation in `meta.organisation_id`
            requires two-factor authentication and the caller's session does not
            satisfy it. The caller must set up or use a second factor, or sign
            in through their organisation's SAML single sign-on. Other OIDC
            sign-ins do not count.
          type: string
          examples:
            - AUTH.001
            - CH.003.080
        source:
          description: A JSON object containing additional information about the error.
          type: object
          properties:
            pointer:
              description: >-
                A JSON Pointer to the value in the request that caused the
                error.
              type: string
              examples:
                - /data/attributes/email
            parameter:
              description: >-
                A string indicating which query parameter in the request caused
                the error.
              type: string
              examples:
                - include
        meta:
          description: >-
            A JSON object containing additional information about the error.

            When a parameter caused the error, there will be a `resource`
            property with the name of the resource that caused the error.

            When `code` is `CH.003.080`, `organisation_id` names the
            organisation that requires two-factor authentication, which the
            caller's session does not satisfy.

            When `code` is `CH.029.016`, `retry_after` is the number of seconds
            to wait before sending feedback again. It matches the `Retry-After`
            header, which a browser on another origin cannot read.
          type: object
          properties:
            resource:
              type: string
              description: >-
                The resource a parameter error relates to, such as an
                unsupported include.
            organisation_id:
              type: string
              format: uuid
              examples:
                - c000c344-8847-47da-a091-32e75902d3b1
            retry_after:
              type: integer
              minimum: 1
              description: Seconds to wait before trying the request again.
              examples:
                - 1200
          additionalProperties: true
      required:
        - id
        - status
        - title
    ExposureDayAttributes:
      type: object
      description: Attributes of an exposure day
      required:
        - exposure_type
        - unit
        - date
        - total
        - band
        - weekly_total
        - weekly_band
        - amber
        - red
        - weekly_amber
        - weekly_red
        - source
      properties:
        exposure_type:
          $ref: '#/components/schemas/ExposureType'
        unit:
          type: string
          description: The unit the totals and limits are in, such as `points` for HAVS.
          examples:
            - points
        date:
          type: string
          format: date
          description: >-
            The Europe/London calendar day. A record counts towards the day it
            starts on.
        total:
          type: number
          format: double
          description: >-
            The person's total that day, from their records in every
            organisation.
          examples:
            - 420
        band:
          $ref: '#/components/schemas/ExposureBand'
        weekly_total:
          type: number
          format: double
          description: >-
            The person's total over the rolling 7 days ending on `date`, from
            their records in every organisation.
          examples:
            - 1240
        weekly_band:
          $ref: '#/components/schemas/ExposureBand'
        amber:
          type: number
          format: double
          description: The daily action value in force that day.
          examples:
            - 100
        red:
          type: number
          format: double
          description: The daily limit value in force that day.
          examples:
            - 400
        weekly_amber:
          type: number
          format: double
          description: The action value over the rolling 7 days ending on `date`.
          examples:
            - 500
        weekly_red:
          type: number
          format: double
          description: The limit value over the rolling 7 days ending on `date`.
          examples:
            - 2000
        source:
          type: string
          description: >
            The layer that set red, and so `weekly_red`: `hse`, `organisation`
            or `health_plan`, as on an

            effective exposure limit.
          enum:
            - hse
            - organisation
            - health_plan
    ExposureDayRelationships:
      type: object
      description: Relationships for an exposure day
      required:
        - subject
      properties:
        subject:
          type: object
          description: The person the day is for.
          required:
            - data
          properties:
            data:
              $ref: '#/components/schemas/UserRelationship'
    Features:
      type: object
      description: Represents feature configurations of the API
      properties:
        include:
          type: object
          properties:
            options:
              type: array
              items:
                type: string
                examples:
                  - related.resource
    Pagination:
      type: object
      description: Represents pagination details for API responses
      required:
        - counts
        - current_page
        - offsets
        - requested
      properties:
        counts:
          type: object
          required:
            - pages
            - resources
          properties:
            pages:
              type: integer
              examples:
                - 1
            resources:
              type: integer
              examples:
                - 1
        current_page:
          type: integer
          examples:
            - 1
        offsets:
          type: object
          required:
            - next
            - previous
          properties:
            next:
              type:
                - integer
                - 'null'
              examples:
                - null
            previous:
              type:
                - integer
                - 'null'
              examples:
                - null
        requested:
          type: object
          required:
            - limit
            - offset
          properties:
            limit:
              type: integer
              examples:
                - 10
            offset:
              type: integer
              examples:
                - 0
    ExposureBand:
      type: string
      description: >
        Where a total falls against its limit: `green` below amber, `amber` at
        or above amber and below red

        (near-limit), `red` at or above red (breach).
      enum:
        - green
        - amber
        - red
    UserRelationship:
      type: object
      description: Represents a relationship to a user
      required:
        - id
        - type
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the user
        type:
          type: string
          const: users
  headers:
    content-type:
      description: The content type of the response
      schema:
        type: string
      example: application/vnd.api+json
    content-length:
      description: The length of the response body in bytes
      schema:
        type: integer
        format: int32
      example: 1234
    x-request-id:
      description: >-
        An ID that can be provided when reporting bugs to help identify the
        issue
      schema:
        type: string
      example: 8470f56af4cf25e22be08e72c70dbbdc
  securitySchemes:
    Session:
      description: |
        Session token for authentication.
      in: header
      name: X-Session-Token
      type: apiKey
    OAuth2:
      description: |
        OAuth2 token for authentication.
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://auth.ctrl-hub.com/oauth2/token
      type: oauth2
    Cookie:
      description: |
        Cookie token for authentication.
      in: cookie
      name: ctrl_hub_session
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.