openapi: 3.0.0
info:
  title: Scannable Equipment Owner API
  description: >-
    Scannable REST API for equipment owners: connect your own systems to the
    equipment, people and teams you manage in Scannable.


    ## Authentication


    Send your API key in the `Authorization` header, as a bearer token:


    ```

    Authorization: Bearer <your-key>

    ```


    Create the key in the Scannable admin: **Settings → API Keys → Create API
    key**, and give it only the scopes it needs. The key is only shown once, so
    copy it before closing the modal.


    Check a key with `GET /v1/auth/me`, which returns the identity it
    authenticates as. A request without a valid key is rejected with `401`; a
    key without the scope an endpoint needs is rejected with `403`.
  version: "1.0"
  contact: {}
servers:
  - url: https://api.scannable.io
    description: Production
security:
  - ApiKey: []
tags:
  - name: Auth
    description: The identity your API key authenticates as.
  - name: Members
    description: The people in your organisation, whatever their role. This is wider
      than the Member role, which a member’s `role` shows as `member`. Someone
      you invite becomes a member once they accept and sign up.
  - name: Teams
    description: Groups of the members of your organisation. Available to
      manufacturers and equipment owners alike.
  - name: Folders
    description: "The places you keep equipment in: kit bags, locations, vehicles
      and the other folder types, nested in a tree."
  - name: Labels
    description: The labels you tag items with, such as "Rescue kit". An item lists
      its labels, and the items list filters by one.
  - name: Items
    description: "The equipment in your inventory: each item with its status,
      folder, assignee, labels and inspection dates, its field values and
      inspection frequencies, and its history."
  - name: Inspections
    description: "The inspections of the items in your inventory: the outcome, who
      carried each one out, and for a single inspection its checklist results,
      photos and PDFs. An item’s inspections from before your organisation held
      it are included without the inspector, notes or files."
  - name: Checklists
    description: Your organisation’s inspection checklists and the checks on each.
      Checklists a manufacturer provides for its products aren’t listed here,
      though an inspection made against one shows its name and results.
  - name: Examinations
    description: "Thorough examinations: a set of inspections issued together as one
      report, such as an annual LOLER examination. Download the report as a
      PDF."
  - name: Inspection frequencies
    description: Your inspection schedules, such as every six months. Applied to an
      item, each sets when its next inspection is due; an item lists the ones
      applied to it.
paths:
  /v1/folders:
    get:
      description: "Returns the folders in your organisation, by name. Pass `parent`
        to list the folders directly inside one folder, or `parent=none` for
        those at the top level; leave it out to list every folder. Narrow any of
        these with `type`. An API key sees every folder, restricted ones
        included. An OAuth caller sees the folders their role and permissions
        allow. Pages by cursor: pass each response’s `next_cursor` as `cursor`
        until it is null."
      operationId: folders_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: type
          required: false
          in: query
          description: Only folders of this type.
          schema:
            example: kit_bag
            type: string
            enum:
              - default
              - kit_bag
              - location
              - vehicle
              - client
              - equipment_type
              - staff
        - name: parent
          required: false
          in: query
          description: Only the folders directly inside this one, as a `folder_…`
            identifier, or `none` for the folders at the top level. Leave it out
            to list every folder. A folder of another organisation returns
            `404`.
          schema:
            example: folder_zeoaiw6e0bc95bl
            type: string
      responses:
        "200":
          description: A page of your folders, by name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FolderListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid `limit` or filter parameters, or a `cursor` this endpoint
            didn’t return (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `folders:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'The `parent` filter names no folder you can see in your
            organisation (`code: "not_found"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List folders
      tags:
        - Folders
      x-scannable-actions:
        - View folders
  /v1/folders/{folder_id}:
    get:
      description: Returns one folder in your organisation, with the members and teams
        that have a permission on it. An API key can read a restricted folder.
        An OAuth caller can read it only with access to it.
      operationId: folders_get
      parameters:
        - name: folder_id
          required: true
          in: path
          description: The `folder_…` identifier of a folder in your organisation.
          schema:
            example: folder_z7n9dlj7vy13rpj
            type: string
      responses:
        "200":
          description: The requested folder.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FolderDetailResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `folders:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No folder with this identifier exists in your organisation, or an
            OAuth caller may not see it (`code: "not_found"`). A folder of
            another organisation reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve a folder
      tags:
        - Folders
      x-scannable-actions:
        - View folders
  /v1/labels:
    get:
      description: Returns the labels in your organisation, by name. Pass each
        response’s `next_cursor` as `cursor` to fetch the next page, until it is
        null.
      operationId: labels_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
      responses:
        "200":
          description: A page of your labels, by name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LabelListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination parameters (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `items:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List labels
      tags:
        - Labels
      x-scannable-actions:
        - View labels
  /v1/items:
    get:
      description: Returns the items in your inventory, oldest `created_at` first, or
        soonest due first with `sort=next_inspection_at`. An API key reads your
        whole organisation, whatever folder permissions say. Find an item with
        `serial_number`, `nfc_tag` or `q` (text in the serial number, name,
        product or SKU). Add `include=data_fields,inspection_frequencies` to get
        what the single item carries without a call per item. Narrow the list
        with `folder_id` (which includes the folders inside it), `label_id`,
        `assigned_to`, `status`, `product_id`, `sku_id`,
        `next_inspection_before`, `next_inspection_after` and `expires_before`.
        Archived items are left out unless you send `archived=true`. Pass each
        response’s `next_cursor` as `cursor` to fetch the next page, until it is
        null.
      operationId: items_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: serial_number
          required: false
          in: query
          description: Only the item with this serial number, ignoring case. A serial
            number is unique only within a product, so more than one item can
            match.
          schema:
            example: 21H0042871
            type: string
        - name: q
          required: false
          in: query
          description: Only the items whose serial number, batch number, name, product
            name, SKU name, part number or PO number contains this text,
            ignoring case, or whose NFC tag is this text.
          schema:
            example: RWH-24
            type: string
        - name: nfc_tag
          required: false
          in: query
          description: Only the item linked to this NFC tag, by the tag’s id as scanned in
            either byte order, ignoring case.
          schema:
            example: 04A23B1A6E5D80
            type: string
        - name: folder_id
          required: false
          in: query
          description: Only the items held in any of these folders or a folder inside one.
            A folder of another organisation matches nothing. Separate several
            with commas.
          schema:
            example: folder_0oiuplyrd7v1tw7
            type: string
        - name: label_id
          required: false
          in: query
          description: Only the items with any of these labels. A label of another
            organisation matches nothing. Separate several with commas.
          schema:
            example: label_14nvy9743mll6el
            type: string
        - name: assigned_to
          required: false
          in: query
          description: Only the items assigned to any of these members. A member of
            another organisation matches nothing. Separate several with commas.
          schema:
            example: member_tsyqfxifv1te4qf
            type: string
        - name: status
          required: false
          in: query
          description: Only the items with any of these safety statuses. Separate several
            with commas, such as `not_safe_failed,not_safe_overdue`.
          schema:
            example: not_safe_failed,not_safe_overdue
            type: string
        - name: product_id
          required: false
          in: query
          description: Only the items of any of these products. Separate several with
            commas.
          schema:
            example: prod_hqycu1g6t1yyt16
            type: string
        - name: sku_id
          required: false
          in: query
          description: Only the items of any of these SKUs. Separate several with commas.
          schema:
            example: sku_wnpil4kqbhgv5o5
            type: string
        - name: next_inspection_before
          required: false
          in: query
          description: Only the items whose next inspection is due before this time (ISO
            8601). Items with no inspection due are left out.
          schema:
            example: 2026-06-30T23:59:59.999Z
            type: string
        - name: next_inspection_after
          required: false
          in: query
          description: Only the items whose next inspection is due at or after this time
            (ISO 8601). Items with no inspection due are left out.
          schema:
            example: 2026-01-01T00:00:00.000Z
            type: string
        - name: expires_before
          required: false
          in: query
          description: Only the items that expire before this time (ISO 8601). Items with
            no expiry are left out.
          schema:
            example: 2026-06-30T23:59:59.999Z
            type: string
        - name: include
          required: false
          in: query
          description: "Adds to each item what the single item carries: `data_fields`,
            `inspection_frequencies`, or both, comma-separated. Saves retrieving
            each item on its own."
          schema:
            example: data_fields,inspection_frequencies
            type: string
        - name: sort
          required: false
          in: query
          description: The order of the list. `created_at` (the default) lists the oldest
            items first. `next_inspection_at` lists the items due soonest first,
            overdue ones included, and those with no next inspection last.
          schema:
            default: created_at
            type: string
            enum:
              - created_at
              - next_inspection_at
        - name: archived
          required: false
          in: query
          description: Send `true` for the items you have archived. Omit it or send
            `false` for the rest.
          schema:
            type: boolean
      responses:
        "200":
          description: A page of your items.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ItemListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination or filter parameters (`code:
            "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `items:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List items
      tags:
        - Items
      x-scannable-actions:
        - View Inventory
  /v1/items/{item_id}:
    get:
      description: Returns one item in your inventory, archived or not, with the
        values of your organisation’s fields and the inspection frequencies
        applied to it. Address it by its `item_…` identifier, or by the
        `serial_…` identifier the manufacturer API uses for the same item.
      operationId: items_get
      parameters:
        - name: item_id
          required: true
          in: path
          description: The `item_…` identifier of an item in your inventory. The
            `serial_…` identifier of the same item works too.
          schema:
            example: item_gdwadfjn13zb7o5
            type: string
      responses:
        "200":
          description: The requested item.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ItemDetailResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `items:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No item with this identifier is in your inventory (`code:
            "not_found"`). An item held only by another organisation reads the
            same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve an item
      tags:
        - Items
      x-scannable-actions:
        - View Inventory
  /v1/items/{item_id}/history:
    get:
      description: "Returns the events recorded against an item in your inventory,
        newest first. From before your organisation began holding the item, only
        its inspections show, without who carried them out. It leaves out other
        organisations’ labels and the manufacturer’s own operations, and a
        manufacturer’s inspections show without the inspector. Filter by
        `group`. Pages by cursor, unlike other lists, so events recorded while
        you page are never skipped or repeated: pass each response’s
        `next_cursor` as `cursor` until it is null."
      operationId: items_list_history
      parameters:
        - name: item_id
          required: true
          in: path
          description: The `item_…` identifier of an item in your inventory. The
            `serial_…` identifier of the same item works too.
          schema:
            example: item_gdwadfjn13zb7o5
            type: string
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: group
          required: false
          in: query
          description: Only events of this kind.
          schema:
            example: inspections
            type: string
            enum:
              - scans
              - inspections
              - usage_and_tasks
              - assignments
              - inventory
              - assembly
              - record
      responses:
        "200":
          description: A page of the item’s events, newest first.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ItemHistoryListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid `limit` or `group`, or a `cursor` this endpoint didn’t
            return (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `items:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No item with this identifier is in your inventory (`code:
            "not_found"`). An item held only by another organisation reads the
            same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List the history of an item
      tags:
        - Items
      x-scannable-actions:
        - View Inventory
  /v1/auth/me:
    get:
      description: "Returns the organisation you act in, its type, and who you are:
        how you authenticated, the user you act as, and the `roles` or `scopes`
        your requests are judged against. Any API key with at least one scope
        can call this endpoint. Check `roles` (OAuth) or `scopes` (API key) to
        predict a 403."
      operationId: auth_me
      parameters: []
      responses:
        "200":
          description: Your organisation, its type, and your identity.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthMeResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your OAuth role or plan does not permit this, or your organisation
            is not a manufacturer (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Get the authenticated identity
      tags:
        - Auth
      x-scannable-actions:
        - View organisation details
  /v1/teams:
    get:
      description: Returns the teams in your organisation, by name. Find teams by name
        with `q`. Filter to the teams one member belongs to with `member`, to
        teams with or without members with `empty`, and by creation time with
        `created_after` and `created_before`. Pass each response’s `next_cursor`
        as `cursor` to fetch the next page, until it is null.
      operationId: teams_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: q
          required: false
          in: query
          description: Only teams whose name contains this text, ignoring case, such as
            `rig` for `Riggers`.
          schema:
            type: string
        - name: member
          required: false
          in: query
          description: Only the teams this member belongs to. A `member_` identifier from
            the members list, such as `member_flffmtixhdzcnwf`. A member of
            another organisation returns `404`.
          schema:
            type: string
        - name: empty
          required: false
          in: query
          description: Omit for all teams, `true` for only teams with no members, `false`
            for only teams with at least one. `true` cannot be combined with
            `member`.
          schema:
            type: boolean
        - name: created_after
          required: false
          in: query
          description: Only teams created at or after this time, as an ISO 8601 date-time
            such as `2026-01-01T00:00:00Z`.
          schema:
            format: date-time
            type: string
        - name: created_before
          required: false
          in: query
          description: Only teams created at or before this time, as an ISO 8601 date-time
            such as `2026-06-30T23:59:59Z`.
          schema:
            format: date-time
            type: string
      responses:
        "200":
          description: A page of your teams, by name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TeamListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination or filter parameters, or filters that
            contradict each other: `empty=true` with `member`, or
            `created_after` later than `created_before` (`code:
            "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `teams:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'The `member` filter names no member of your organisation (`code:
            "not_found"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List teams
      tags:
        - Teams
      x-scannable-actions:
        - View teams
  /v1/teams/{team_id}:
    get:
      description: Returns one team in your organisation.
      operationId: teams_get
      parameters:
        - name: team_id
          required: true
          in: path
          description: The `team_…` identifier of a team in your organisation.
          schema:
            example: team_45ylkvywouutob2
            type: string
      responses:
        "200":
          description: The requested team.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TeamResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `teams:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No team with this identifier exists in your organisation (`code:
            "not_found"`). A team of another organisation reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve a team
      tags:
        - Teams
      x-scannable-actions:
        - View teams
  /v1/teams/{team_id}/members:
    get:
      description: Returns the members of a team in your organisation, by last name
        and then first name. Pass each response’s `next_cursor` as `cursor` to
        fetch the next page, until it is null.
      operationId: teams_list_members
      parameters:
        - name: team_id
          required: true
          in: path
          description: The `team_…` identifier of a team in your organisation.
          schema:
            example: team_45ylkvywouutob2
            type: string
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
      responses:
        "200":
          description: A page of the team’s members.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TeamMemberListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination parameters (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `teams:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No team with this identifier exists in your organisation (`code:
            "not_found"`). A team of another organisation reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List the members of a team
      tags:
        - Teams
      x-scannable-actions:
        - View teams
  /v1/members:
    get:
      description: Returns the members of your organisation, by last name and then
        first name. Narrow them with `email` (the whole address, any case),
        `role`, `competent_person` and `in_team`. Pass each response’s
        `next_cursor` as `cursor` to fetch the next page, until it is null.
      operationId: members_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: email
          required: false
          in: query
          description: Only the member with this email address, such as
            `sam.carter@example.com`. The whole address must match; case is
            ignored.
          schema:
            type: string
        - name: role
          required: false
          in: query
          description: Only members with this role in your organisation.
          schema:
            type: string
            enum:
              - admin
              - manager
              - member
              - supplier
              - user
        - name: competent_person
          required: false
          in: query
          description: Omit for everyone, `true` for only competent persons, `false` for
            only members who are not.
          schema:
            type: boolean
        - name: in_team
          required: false
          in: query
          description: Omit for everyone, `true` for only members in at least one team,
            `false` for only members in no team.
          schema:
            type: boolean
      responses:
        "200":
          description: A page of your members.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MemberListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination or filter parameters (`code:
            "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `members:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List members
      tags:
        - Members
      x-scannable-actions:
        - View organisation users
  /v1/members/{member_id}:
    get:
      description: Returns one member of your organisation.
      operationId: members_get
      parameters:
        - name: member_id
          required: true
          in: path
          description: The `member_…` identifier of a member of your organisation.
          schema:
            example: member_0shacc5ppeye6v5
            type: string
      responses:
        "200":
          description: The member.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MemberResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `members:read` scope, or your OAuth role or
            plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No member with this identifier exists in your organisation (`code:
            "not_found"`). A member of another organisation reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve a member
      tags:
        - Members
      x-scannable-actions:
        - View one organisation user
  /v1/inspection-frequencies:
    get:
      description: Returns your inspection frequencies by name. Narrow them with
        `type` and `status`. Pass each response’s `next_cursor` as `cursor` to
        fetch the next page, until it is null.
      operationId: inspection_frequencies_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: type
          required: false
          in: query
          description: Only the inspection frequencies for this kind of inspection.
          schema:
            type: string
            enum:
              - thorough
              - general
        - name: status
          required: false
          in: query
          description: Only the active or only the paused inspection frequencies.
          schema:
            type: string
            enum:
              - active
              - paused
      responses:
        "200":
          description: A page of your inspection frequencies.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InspectionFrequencyListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination or filter parameters (`code:
            "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspection-frequencies:read` scope, or
            your OAuth role or plan does not permit this (`code:
            "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List inspection frequencies
      tags:
        - Inspection frequencies
      x-scannable-actions:
        - View inspection frequencies
  /v1/inspection-frequencies/{frequency_id}:
    get:
      description: Returns one of your inspection frequencies.
      operationId: inspection_frequencies_get
      parameters:
        - name: frequency_id
          required: true
          in: path
          description: The `freq_…` identifier of one of your inspection frequencies.
          schema:
            example: freq_fu760equhw69jld
            type: string
      responses:
        "200":
          description: The requested inspection frequency.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InspectionFrequencyResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspection-frequencies:read` scope, or
            your OAuth role or plan does not permit this (`code:
            "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No inspection frequency with this identifier belongs to your
            organisation (`code: "not_found"`). Another organisation’s reads the
            same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve an inspection frequency
      tags:
        - Inspection frequencies
      x-scannable-actions:
        - View inspection frequencies
  /v1/inspections:
    get:
      description: "Returns the inspections of the items in your inventory, most
        recently carried out first; inspections with no recorded date come last.
        Narrow them with `item_id`, `status`, `type`, `inspector`,
        `inspected_after` and `inspected_before`. Pages by cursor, so
        inspections recorded while you page are never skipped or repeated: pass
        each response’s `next_cursor` as `cursor` until it is null."
      operationId: inspections_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: item_id
          required: false
          in: query
          description: "Only the inspections of this item: its `item_…` identifier, or the
            `serial_…` one. An item of another organisation returns an empty
            page."
          schema:
            example: item_gdwadfjn13zb7o5
            type: string
        - name: status
          required: false
          in: query
          description: "Only the inspections with any of these outcomes. Separate several
            with commas, such as `failed,quarantined`. One of: `passed`,
            `failed`, `quarantined`, `monitoring`."
          schema:
            example: failed,quarantined
            type: string
        - name: type
          required: false
          in: query
          description: "Only the inspections of any of these kinds. Separate several with
            commas. One of: `thorough`, `general`."
          schema:
            example: thorough
            type: string
        - name: inspector
          required: false
          in: query
          description: Only the inspections this member carried out. A member of another
            organisation returns an empty page.
          schema:
            example: member_tsyqfxifv1te4qf
            type: string
        - name: inspected_after
          required: false
          in: query
          description: Only the inspections carried out at or after this time (ISO 8601).
            Inspections with no recorded date are left out.
          schema:
            example: 2026-01-01T00:00:00.000Z
            type: string
        - name: inspected_before
          required: false
          in: query
          description: Only the inspections carried out at or before this time (ISO 8601).
            Inspections with no recorded date are left out.
          schema:
            example: 2026-06-30T23:59:59.999Z
            type: string
      responses:
        "200":
          description: A page of your inspections.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InspectionListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid `limit` or filter parameters, `inspected_after` later than
            `inspected_before`, or a `cursor` this endpoint didn’t return
            (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspections:read` scope, or your OAuth
            role or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List inspections
      tags:
        - Inspections
      x-scannable-actions:
        - View inspections
  /v1/inspections/{inspection_id}:
    get:
      description: Returns one inspection of an item in your inventory, with the
        checklist it was made against, the result of each check, and its photos
        and PDFs. PDF links work for an hour; photo links don’t expire.
      operationId: inspections_get
      parameters:
        - name: inspection_id
          required: true
          in: path
          description: The `insp_…` identifier of an inspection.
          schema:
            example: insp_7igae9yjg93sht5
            type: string
      responses:
        "200":
          description: The requested inspection.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InspectionDetailResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspections:read` scope, or your OAuth
            role or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No inspection with this identifier is of an item in your inventory
            (`code: "not_found"`). An inspection of another organisation’s item
            reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve an inspection
      tags:
        - Inspections
      x-scannable-actions:
        - View inspections
  /v1/checklists:
    get:
      description: Returns your organisation’s checklists by name. Narrow them with
        `published`. Pass each response’s `next_cursor` as `cursor` to fetch the
        next page, until it is null.
      operationId: checklists_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: published
          required: false
          in: query
          description: Send `true` for the published checklists only, or `false` for the
            unpublished ones. Omit it for both.
          schema:
            type: boolean
      responses:
        "200":
          description: A page of your checklists.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ChecklistListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid pagination or filter parameters (`code:
            "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `checklists:read` scope, or your OAuth role
            or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List checklists
      tags:
        - Checklists
      x-scannable-actions:
        - List checklists
  /v1/checklists/{checklist_id}:
    get:
      description: Returns one of your organisation’s checklists, with its checks in order.
      operationId: checklists_get
      parameters:
        - name: checklist_id
          required: true
          in: path
          description: The `chk_…` identifier of one of your checklists.
          schema:
            example: chk_zsged1q41baxq7s
            type: string
      responses:
        "200":
          description: The requested checklist.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ChecklistDetailResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `checklists:read` scope, or your OAuth role
            or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No checklist with this identifier belongs to your organisation
            (`code: "not_found"`). A manufacturer’s or another organisation’s
            checklist reads the same.'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve a checklist
      tags:
        - Checklists
      x-scannable-actions:
        - View checklists
  /v1/examinations:
    get:
      description: "Returns your examinations, newest first. Narrow them with
        `status`. Pages by cursor: pass each response’s `next_cursor` as
        `cursor` until it is null."
      operationId: examinations_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100). Defaults to 20.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: cursor
          required: false
          in: query
          description: The `next_cursor` of the previous page. Leave it out for the first
            page. A cursor only works with the filters it was issued for.
          schema:
            example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
            type: string
        - name: status
          required: false
          in: query
          description: Only the examinations with this status.
          schema:
            type: string
            enum:
              - active
              - complete
      responses:
        "200":
          description: A page of your examinations.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExaminationListResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "400":
          description: 'Invalid `limit` or `status`, or a `cursor` this endpoint didn’t
            return (`code: "validation_failed"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspections:read` scope, or your OAuth
            role or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: List examinations
      tags:
        - Examinations
      x-scannable-actions:
        - Access examinations
  /v1/examinations/{examination_id}:
    get:
      description: Returns one of your examinations.
      operationId: examinations_get
      parameters:
        - name: examination_id
          required: true
          in: path
          description: The `exam_…` identifier of an examination.
          schema:
            example: exam_u6ff38egif4wibp
            type: string
      responses:
        "200":
          description: The requested examination.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExaminationDetailResponse"
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            ETag:
              description: A tag for this response. Send it back as `If-None-Match` to get
                `304 Not Modified`, with no body, while nothing has changed.
              schema:
                type: string
        "304":
          description: Nothing has changed since the response whose `ETag` you sent as
            `If-None-Match`.
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspections:read` scope, or your OAuth
            role or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No examination of your organisation has this identifier (`code:
            "not_found"`).'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Retrieve an examination
      tags:
        - Examinations
      x-scannable-actions:
        - Access examinations
  /v1/examinations/{examination_id}/pdf:
    get:
      description: Returns the examination’s report as a PDF, built when you ask for it.
      operationId: examinations_pdf
      parameters:
        - name: examination_id
          required: true
          in: path
          description: The `exam_…` identifier of an examination.
          schema:
            example: exam_u6ff38egif4wibp
            type: string
      responses:
        "200":
          description: The report.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
          headers:
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        "401":
          description: 'Missing or invalid credentials — no API key or OAuth token, or one
            that does not verify (`code: "unauthorized"`).'
          content:
            application/pdf:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "403":
          description: 'Your API key lacks the `inspections:read` scope, or your OAuth
            role or plan does not permit this (`code: "forbidden_scope"`).'
          content:
            application/pdf:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "404":
          description: 'No examination of your organisation has this identifier (`code:
            "not_found"`).'
          content:
            application/pdf:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
        "429":
          description: 'Too many requests from this API key, or from this user for an
            OAuth token. Wait for the number of seconds in `Retry-After` (`code:
            "rate_limited"`).'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: Requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiErrorResponse"
      security:
        - ApiKey: []
      summary: Download an examination report
      tags:
        - Examinations
      x-scannable-actions:
        - Access examinations
components:
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: "Your organisation's API key. Send it as `Authorization: Bearer
        <key>`. Create one in the Scannable admin under Settings → API keys."
  schemas:
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Stable, machine-readable error code.
          example: not_found
        message:
          type: string
          description: Human-readable summary of what went wrong.
          example: No SKU with this id exists for your organisation.
        details:
          type: object
          description: "Structured detail: field-level errors keyed by path on a
            validation failure, or the values a request named that do not
            exist."
          example:
            errors: []
            properties:
              part_number:
                errors:
                  - Required
        fields:
          description: "On a validation failure, one entry per problem: the request field
            by dotted path, and what is wrong with it. An unknown query
            parameter reads `Unknown parameter.`"
          example:
            - field: status
              message: Invalid status.
          type: array
          items:
            type: string
        hint:
          type: string
          description: What to do next, when the error has a known remedy, such as which
            API an organisation should use instead.
          example: Manufacturer organisations use the manufacturer API (products, SKUs and
            serials) instead.
        request_id:
          type: string
          description: Correlation id for this request; quote it when reporting a problem.
          example: req_01j9x4m2k7qv3n8r5t6w0y1z2a
      required:
        - code
        - message
        - request_id
    ApiErrorResponse:
      type: object
      properties:
        error:
          $ref: "#/components/schemas/ApiError"
      required:
        - error
    FolderListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The folder identifier you use to address it in the API.
                example: folder_z7n9dlj7vy13rpj
              name:
                type: string
                description: The name of the folder.
                example: Van 3
              type:
                type: string
                enum:
                  - default
                  - kit_bag
                  - location
                  - vehicle
                  - client
                  - equipment_type
                  - staff
                description: "What the folder is: a kit bag, a location, a vehicle and so on."
                example: vehicle
              parent:
                type: object
                properties:
                  id:
                    type: string
                    description: The folder identifier.
                    example: folder_zeoaiw6e0bc95bl
                  name:
                    type: string
                    description: The folder name.
                    example: Queenstown Depot
                required:
                  - id
                  - name
                description: The folder this one sits in, or `null` for a folder at the top
                  level.
                nullable: true
              restricted:
                type: boolean
                description: Whether Managers and Members need a permission to see the folder.
                  True when this folder or any folder above it is restricted.
                example: false
              created_at:
                type: string
                description: When the folder was created (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
            required:
              - id
              - name
              - type
              - parent
              - restricted
              - created_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    FolderDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: The folder identifier you use to address it in the API.
          example: folder_z7n9dlj7vy13rpj
        name:
          type: string
          description: The name of the folder.
          example: Van 3
        type:
          type: string
          enum:
            - default
            - kit_bag
            - location
            - vehicle
            - client
            - equipment_type
            - staff
          description: "What the folder is: a kit bag, a location, a vehicle and so on."
          example: vehicle
        parent:
          type: object
          properties:
            id:
              type: string
              description: The folder identifier.
              example: folder_zeoaiw6e0bc95bl
            name:
              type: string
              description: The folder name.
              example: Queenstown Depot
          required:
            - id
            - name
          description: The folder this one sits in, or `null` for a folder at the top level.
          nullable: true
        restricted:
          type: boolean
          description: Whether Managers and Members need a permission to see the folder.
            True when this folder or any folder above it is restricted.
          example: false
        created_at:
          type: string
          description: When the folder was created (ISO 8601).
          example: 2026-03-02T09:30:00.000Z
        permissions:
          type: array
          items:
            type: object
            properties:
              member:
                description: The member granted the folder. Set when the permission names a
                  member.
                type: object
                properties:
                  id:
                    type: string
                    description: The member identifier.
                    example: member_0shacc5ppeye6v5
                  name:
                    type: string
                    description: The member name.
                    example: Mere Walker
                required:
                  - id
                  - name
              team:
                description: The team granted the folder. Set when the permission names a team;
                  its members are not listed here.
                type: object
                properties:
                  id:
                    type: string
                    description: The team identifier.
                    example: team_1mw8uo1xpt48tc2
                  name:
                    type: string
                    description: The team name.
                    example: Rope Access Crew
                required:
                  - id
                  - name
              source:
                type: string
                enum:
                  - explicit
                  - inherited
                description: "`explicit` when the permission is on this folder, `inherited` when
                  it is on a folder above it."
                example: explicit
              from_folder_id:
                description: For an inherited permission, the `folder_…` identifier of the
                  folder it is on.
                example: folder_zeoaiw6e0bc95bl
                type: string
            required:
              - source
          description: The members and teams with a permission on this folder, whether set
            on it or inherited from a folder above, up to the nearest restricted
            one. Users and Suppliers see a folder only through a permission;
            Managers and Members need one when the folder is restricted. Admins
            see every folder and are not listed.
      required:
        - id
        - name
        - type
        - parent
        - restricted
        - created_at
        - permissions
    LabelListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The label identifier you use to address it in the API.
                example: label_b2y6zp7hhpv76de
              name:
                type: string
                description: The name of the label.
                example: Rescue kit
              created_at:
                type: string
                description: When the label was created (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
            required:
              - id
              - name
              - created_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    ItemListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The item identifier you use to address it in the API.
                example: item_gdwadfjn13zb7o5
              serial_id:
                type: string
                description: The same item as the `serial_…` identifier the manufacturer API
                  uses. Either identifier addresses the item in the item routes.
                example: serial_gdwadfjn13zb7o5
              serial_number:
                description: The serial number of the item, if it has one.
                example: 21H0042871
                type: string
                nullable: true
              name:
                description: The name you gave the item, if any.
                example: Harness 12
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - safe_passed
                  - not_safe_failed
                  - not_safe_expired
                  - not_safe_overdue
                  - not_safe_quarantined
                  - not_safe_recalled
                  - not_safe_not_inspected
                  - safety_notice
                  - none
                description: "The safety status of the item: `safe_passed`, `not_safe_failed`,
                  `not_safe_expired`, `not_safe_overdue`,
                  `not_safe_quarantined`, `not_safe_recalled`,
                  `not_safe_not_inspected`, `safety_notice` or `none`."
                example: safe_passed
              product:
                type: object
                properties:
                  id:
                    type: string
                    description: The product identifier (`prod_…`).
                    example: prod_hqycu1g6t1yyt16
                  name:
                    type: string
                    description: The product name.
                    example: AVAO BOD FAST
                  manufacturer:
                    type: string
                    description: The name of the manufacturer that makes the product.
                    example: Petzl
                required:
                  - id
                  - name
                  - manufacturer
                description: What the item is an item of. Null for an item with no catalogue
                  product.
                nullable: true
              sku:
                type: object
                properties:
                  id:
                    type: string
                    description: The SKU identifier (`sku_…`).
                    example: sku_wnpil4kqbhgv5o5
                  part_number:
                    type: string
                    description: The manufacturer’s part number for the SKU.
                    example: C071CA01
                  name:
                    description: The SKU name, if it has one.
                    example: AVAO BOD FAST, size 1
                    type: string
                    nullable: true
                required:
                  - id
                  - part_number
                  - name
                description: The SKU the item is an item of. Null for an item with no SKU.
                nullable: true
              folder:
                type: object
                properties:
                  id:
                    type: string
                    description: The folder identifier.
                    example: folder_0oiuplyrd7v1tw7
                  name:
                    type: string
                    description: The folder name.
                    example: Rope Access Kit
                required:
                  - id
                  - name
                description: The folder that holds the item. Null for an item at the top level
                  of your inventory.
                nullable: true
              assigned_to:
                type: object
                properties:
                  id:
                    type: string
                    description: The member identifier.
                    example: member_tsyqfxifv1te4qf
                  name:
                    type: string
                    description: The member name.
                    example: Mere Walker
                required:
                  - id
                  - name
                description: The member the item is assigned to. Null for an unassigned item.
                nullable: true
              labels:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The label identifier (`label_…`).
                      example: label_14nvy9743mll6el
                    name:
                      type: string
                      description: The name of the label.
                      example: Rescue kit
                  required:
                    - id
                    - name
                description: Your labels on the item, by name.
              manufactured_at:
                type: string
                description: When the item was manufactured (ISO 8601), if recorded.
                example: 2026-03-04T14:05:00.000Z
                nullable: true
              first_used_at:
                type: string
                description: When the item was first used (ISO 8601), if recorded.
                example: 2026-03-04T14:05:00.000Z
                nullable: true
              expires_at:
                type: string
                description: When the item expires (ISO 8601), if it has an expiry.
                example: 2026-03-04T14:05:00.000Z
                nullable: true
              last_inspection:
                type: object
                properties:
                  id:
                    type: string
                    description: The inspection identifier (`insp_…`).
                    example: insp_7igae9yjg93sht5
                  status:
                    type: string
                    enum:
                      - passed
                      - failed
                      - quarantined
                      - monitoring
                    description: "The outcome: `passed`, `failed`, `quarantined` or `monitoring`."
                    example: failed
                  type:
                    type: string
                    enum:
                      - thorough
                      - general
                    description: "The kind of inspection: `thorough` or `general`."
                    example: thorough
                  inspected_at:
                    type: string
                    description: When it was carried out (ISO 8601), or null if no date was
                      recorded.
                    example: 2026-03-04T14:05:00.000Z
                    nullable: true
                  notes:
                    description: The notes recorded with it, if any.
                    example: Webbing abraded behind the rear D-ring.
                    type: string
                    nullable: true
                required:
                  - id
                  - status
                  - type
                  - inspected_at
                  - notes
                description: The latest inspection of the item, so its result and notes come
                  without another call. Null if it has never been inspected.
                nullable: true
              next_inspection_at:
                type: string
                description: When the next inspection is due (ISO 8601), if one is.
                example: 2026-03-04T14:05:00.000Z
                nullable: true
              archived:
                type: boolean
                description: Whether you have archived the item in your inventory.
                example: false
              created_at:
                type: string
                description: When the item was created (ISO 8601).
                example: 2026-03-04T14:05:00.000Z
              data_fields:
                description: "With `include=data_fields`: as on the single item."
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The data field identifier (`data_…`). The same field has the same
                        identifier on every item.
                      example: data_cztnsj2mtmvfb82
                    name:
                      type: string
                      description: The name of the field.
                      example: Asset tag
                    type:
                      type: string
                      enum:
                        - text
                        - number
                        - boolean
                        - date
                        - url
                      description: "How to read `value`: `text`, `number`, `boolean`, `date` (ISO
                        8601) or `url`."
                      example: text
                    value:
                      description: The value set on this item, typed by `type`.
                      example: AT-0042
                      anyOf:
                        - type: string
                        - type: number
                        - type: boolean
                    unit:
                      description: The unit of the value, for fields that have units.
                      example: m
                      type: string
                      nullable: true
                    visibility:
                      type: string
                      enum:
                        - public
                        - internal
                      description: "`public` fields also show on the item’s public page; `internal`
                        ones only to your organisation."
                      example: internal
                  required:
                    - id
                    - name
                    - type
                    - value
                    - unit
                    - visibility
              inspection_frequencies:
                description: "With `include=inspection_frequencies`: as on the single item."
                type: array
                items:
                  type: object
                  properties:
                    frequency_id:
                      type: string
                      description: The inspection frequency applied (`freq_…`).
                      example: freq_fu760equhw69jld
                    name:
                      type: string
                      description: The name of the inspection frequency.
                      example: 6-monthly thorough
                    due_at:
                      type: string
                      description: When the next inspection under it is due (ISO 8601).
                      example: 2026-03-04T14:05:00.000Z
                    starts_at:
                      type: string
                      description: When the schedule started (ISO 8601), if it has a start.
                      example: 2026-03-04T14:05:00.000Z
                      nullable: true
                  required:
                    - frequency_id
                    - name
                    - due_at
                    - starts_at
            required:
              - id
              - serial_id
              - serial_number
              - name
              - status
              - product
              - sku
              - folder
              - assigned_to
              - labels
              - manufactured_at
              - first_used_at
              - expires_at
              - last_inspection
              - next_inspection_at
              - archived
              - created_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    ItemDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: The item identifier you use to address it in the API.
          example: item_gdwadfjn13zb7o5
        serial_id:
          type: string
          description: The same item as the `serial_…` identifier the manufacturer API
            uses. Either identifier addresses the item in the item routes.
          example: serial_gdwadfjn13zb7o5
        serial_number:
          description: The serial number of the item, if it has one.
          example: 21H0042871
          type: string
          nullable: true
        name:
          description: The name you gave the item, if any.
          example: Harness 12
          type: string
          nullable: true
        status:
          type: string
          enum:
            - safe_passed
            - not_safe_failed
            - not_safe_expired
            - not_safe_overdue
            - not_safe_quarantined
            - not_safe_recalled
            - not_safe_not_inspected
            - safety_notice
            - none
          description: "The safety status of the item: `safe_passed`, `not_safe_failed`,
            `not_safe_expired`, `not_safe_overdue`, `not_safe_quarantined`,
            `not_safe_recalled`, `not_safe_not_inspected`, `safety_notice` or
            `none`."
          example: safe_passed
        product:
          type: object
          properties:
            id:
              type: string
              description: The product identifier (`prod_…`).
              example: prod_hqycu1g6t1yyt16
            name:
              type: string
              description: The product name.
              example: AVAO BOD FAST
            manufacturer:
              type: string
              description: The name of the manufacturer that makes the product.
              example: Petzl
          required:
            - id
            - name
            - manufacturer
          description: What the item is an item of. Null for an item with no catalogue
            product.
          nullable: true
        sku:
          type: object
          properties:
            id:
              type: string
              description: The SKU identifier (`sku_…`).
              example: sku_wnpil4kqbhgv5o5
            part_number:
              type: string
              description: The manufacturer’s part number for the SKU.
              example: C071CA01
            name:
              description: The SKU name, if it has one.
              example: AVAO BOD FAST, size 1
              type: string
              nullable: true
          required:
            - id
            - part_number
            - name
          description: The SKU the item is an item of. Null for an item with no SKU.
          nullable: true
        folder:
          type: object
          properties:
            id:
              type: string
              description: The folder identifier.
              example: folder_0oiuplyrd7v1tw7
            name:
              type: string
              description: The folder name.
              example: Rope Access Kit
          required:
            - id
            - name
          description: The folder that holds the item. Null for an item at the top level
            of your inventory.
          nullable: true
        assigned_to:
          type: object
          properties:
            id:
              type: string
              description: The member identifier.
              example: member_tsyqfxifv1te4qf
            name:
              type: string
              description: The member name.
              example: Mere Walker
          required:
            - id
            - name
          description: The member the item is assigned to. Null for an unassigned item.
          nullable: true
        labels:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The label identifier (`label_…`).
                example: label_14nvy9743mll6el
              name:
                type: string
                description: The name of the label.
                example: Rescue kit
            required:
              - id
              - name
          description: Your labels on the item, by name.
        manufactured_at:
          type: string
          description: When the item was manufactured (ISO 8601), if recorded.
          example: 2026-03-04T14:05:00.000Z
          nullable: true
        first_used_at:
          type: string
          description: When the item was first used (ISO 8601), if recorded.
          example: 2026-03-04T14:05:00.000Z
          nullable: true
        expires_at:
          type: string
          description: When the item expires (ISO 8601), if it has an expiry.
          example: 2026-03-04T14:05:00.000Z
          nullable: true
        last_inspection:
          type: object
          properties:
            id:
              type: string
              description: The inspection identifier (`insp_…`).
              example: insp_7igae9yjg93sht5
            status:
              type: string
              enum:
                - passed
                - failed
                - quarantined
                - monitoring
              description: "The outcome: `passed`, `failed`, `quarantined` or `monitoring`."
              example: failed
            type:
              type: string
              enum:
                - thorough
                - general
              description: "The kind of inspection: `thorough` or `general`."
              example: thorough
            inspected_at:
              type: string
              description: When it was carried out (ISO 8601), or null if no date was
                recorded.
              example: 2026-03-04T14:05:00.000Z
              nullable: true
            notes:
              description: The notes recorded with it, if any.
              example: Webbing abraded behind the rear D-ring.
              type: string
              nullable: true
          required:
            - id
            - status
            - type
            - inspected_at
            - notes
          description: The latest inspection of the item, so its result and notes come
            without another call. Null if it has never been inspected.
          nullable: true
        next_inspection_at:
          type: string
          description: When the next inspection is due (ISO 8601), if one is.
          example: 2026-03-04T14:05:00.000Z
          nullable: true
        archived:
          type: boolean
          description: Whether you have archived the item in your inventory.
          example: false
        created_at:
          type: string
          description: When the item was created (ISO 8601).
          example: 2026-03-04T14:05:00.000Z
        data_fields:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The data field identifier (`data_…`). The same field has the same
                  identifier on every item.
                example: data_cztnsj2mtmvfb82
              name:
                type: string
                description: The name of the field.
                example: Asset tag
              type:
                type: string
                enum:
                  - text
                  - number
                  - boolean
                  - date
                  - url
                description: "How to read `value`: `text`, `number`, `boolean`, `date` (ISO
                  8601) or `url`."
                example: text
              value:
                description: The value set on this item, typed by `type`.
                example: AT-0042
                anyOf:
                  - type: string
                  - type: number
                  - type: boolean
              unit:
                description: The unit of the value, for fields that have units.
                example: m
                type: string
                nullable: true
              visibility:
                type: string
                enum:
                  - public
                  - internal
                description: "`public` fields also show on the item’s public page; `internal`
                  ones only to your organisation."
                example: internal
            required:
              - id
              - name
              - type
              - value
              - unit
              - visibility
          description: Your organisation’s own fields that have a value on this item, in
            your field order. File fields are left out.
        inspection_frequencies:
          type: array
          items:
            type: object
            properties:
              frequency_id:
                type: string
                description: The inspection frequency applied (`freq_…`).
                example: freq_fu760equhw69jld
              name:
                type: string
                description: The name of the inspection frequency.
                example: 6-monthly thorough
              due_at:
                type: string
                description: When the next inspection under it is due (ISO 8601).
                example: 2026-03-04T14:05:00.000Z
              starts_at:
                type: string
                description: When the schedule started (ISO 8601), if it has a start.
                example: 2026-03-04T14:05:00.000Z
                nullable: true
            required:
              - frequency_id
              - name
              - due_at
              - starts_at
          description: The inspection frequencies applied to this item, soonest due first.
      required:
        - id
        - serial_id
        - serial_number
        - name
        - status
        - product
        - sku
        - folder
        - assigned_to
        - labels
        - manufactured_at
        - first_used_at
        - expires_at
        - last_inspection
        - next_inspection_at
        - archived
        - created_at
        - data_fields
        - inspection_frequencies
    ItemHistoryListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: "What happened, in snake case: `inspected`, `added_to_inventory`,
                  `assigned_to_user`, `added_to_folder` and so on."
                example: added_to_folder
              title:
                type: string
                description: A short description of the event, in English.
                example: Added to Van 3
              occurred_at:
                type: string
                description: When the event happened (ISO 8601).
                example: 2026-03-04T14:05:00.000Z
              performed_by:
                type: object
                properties:
                  id:
                    description: The member who acted (`member_…`). Null when they are not a member
                      of your organisation, such as an outside inspector or
                      someone at an organisation that held the item before you.
                    example: member_tsyqfxifv1te4qf
                    type: string
                    nullable: true
                  name:
                    description: The name of the person who acted, if recorded.
                    example: Sam Hill
                    type: string
                    nullable: true
                required:
                  - id
                  - name
                description: Who acted. Null when nobody is recorded.
                nullable: true
            required:
              - type
              - title
              - occurred_at
              - performed_by
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    AuthMeResponse:
      type: object
      properties:
        organisation_id:
          type: string
          description: Your organisation identifier, used to address it in the API (e.g.
            `org_abc123`).
          example: org_7h2k9m4p1q8r3s6
        type:
          type: string
          enum:
            - manufacturer
            - equipment_owner
          description: What kind of organisation you act in. A `manufacturer` makes
            products and SKUs. An `equipment_owner` owns and inspects equipment.
        manufacturer_id:
          description: Your manufacturer identifier, the brand your products and SKUs hang
            off (e.g. `man_abc123`). Only present when `type` is `manufacturer`.
          example: man_q4w7e2r9t5y1u3i
          type: string
        member_id:
          description: Your identifier as a member of the organisation (e.g.
            `member_abc123`). For an API key it names the member who created the
            key, and is null once that member has left the organisation.
          example: member_3n8b5v2c7x4z1a9
          type: string
          nullable: true
        name:
          type: string
          description: The display name of your organisation.
          example: Summit Safety Ltd
        created_at:
          type: string
          description: When your organisation was created (ISO 8601).
          example: 2024-05-13T08:00:00.000Z
        auth_method:
          type: string
          enum:
            - api_key
            - oauth
          description: How you authenticated. An `api_key` caller is judged by `scopes`.
            An `oauth` caller is judged by `roles`.
        user:
          type: object
          properties:
            name:
              type: string
              description: Your full name.
              example: Alex Morgan
            email:
              type: string
              description: Your email address.
              example: alex.morgan@summitsafety.example
          required:
            - name
            - email
          description: "The user you act as: the user who authorised your OAuth token.
            Null for an API key, which acts for your organisation rather than
            for the user who created it, so it keeps working after that user
            leaves."
          nullable: true
        roles:
          type: array
          items:
            type: string
            enum:
              - admin
              - manager
              - member
              - supplier
              - user
              - competent_person
              - super_admin
          description: For an `oauth` caller, your roles in the organisation, which decide
            what you may do (for example `["admin"]`). Empty for an API-key
            caller.
        scopes:
          type: array
          items:
            type: string
          description: For an API-key caller, the scopes your key grants (for example
            `serials:read`). On the manufacturer API, an API key with no scopes
            is a legacy key with full access. Empty for an `oauth` caller.
          example:
            - products:read
            - serials:write
      required:
        - organisation_id
        - type
        - member_id
        - name
        - created_at
        - auth_method
        - user
        - roles
        - scopes
    TeamListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The team identifier you use to address it in the API.
                example: team_45ylkvywouutob2
              name:
                type: string
                description: The name of the team.
                example: Riggers
              created_at:
                type: string
                description: When the team was created (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
              updated_at:
                type: string
                description: When the team was last changed (ISO 8601).
                example: 2026-03-04T14:05:00.000Z
            required:
              - id
              - name
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    TeamResponse:
      type: object
      properties:
        id:
          type: string
          description: The team identifier you use to address it in the API.
          example: team_45ylkvywouutob2
        name:
          type: string
          description: The name of the team.
          example: Riggers
        created_at:
          type: string
          description: When the team was created (ISO 8601).
          example: 2026-03-02T09:30:00.000Z
        updated_at:
          type: string
          description: When the team was last changed (ISO 8601).
          example: 2026-03-04T14:05:00.000Z
      required:
        - id
        - name
        - created_at
        - updated_at
    TeamMemberListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              member_id:
                type: string
                description: The member’s identifier in your organisation. It is the same in
                  every team they belong to.
                example: member_0shacc5ppeye6v5
              name:
                type: string
                description: The member’s full name.
                example: Sam Carter
              email:
                type: string
                description: The member’s email address.
                example: sam.carter@example.com
              role:
                type: string
                enum:
                  - admin
                  - manager
                  - member
                  - supplier
                  - user
                description: The member’s role in your organisation.
                example: member
            required:
              - member_id
              - name
              - email
              - role
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    MemberListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The member’s identifier in your organisation, the same one teams
                  use. Someone who leaves and rejoins gets a new one.
                example: member_0shacc5ppeye6v5
              name:
                type: string
                description: The member’s full name.
                example: Sam Carter
              email:
                type: string
                description: The member’s email address.
                example: sam.carter@example.com
              role:
                type: string
                enum:
                  - admin
                  - manager
                  - member
                  - supplier
                  - user
                description: The member’s role in your organisation.
                example: member
              competent_person:
                type: boolean
                description: Whether the member is a competent person for inspections.
                example: false
              created_at:
                type: string
                description: When the member joined your organisation (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
              updated_at:
                type: string
                description: When the membership was last changed (ISO 8601).
                example: 2026-03-04T14:05:00.000Z
            required:
              - id
              - name
              - email
              - role
              - competent_person
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    MemberResponse:
      type: object
      properties:
        id:
          type: string
          description: The member’s identifier in your organisation, the same one teams
            use. Someone who leaves and rejoins gets a new one.
          example: member_0shacc5ppeye6v5
        name:
          type: string
          description: The member’s full name.
          example: Sam Carter
        email:
          type: string
          description: The member’s email address.
          example: sam.carter@example.com
        role:
          type: string
          enum:
            - admin
            - manager
            - member
            - supplier
            - user
          description: The member’s role in your organisation.
          example: member
        competent_person:
          type: boolean
          description: Whether the member is a competent person for inspections.
          example: false
        created_at:
          type: string
          description: When the member joined your organisation (ISO 8601).
          example: 2026-03-02T09:30:00.000Z
        updated_at:
          type: string
          description: When the membership was last changed (ISO 8601).
          example: 2026-03-04T14:05:00.000Z
      required:
        - id
        - name
        - email
        - role
        - competent_person
        - created_at
        - updated_at
    InspectionFrequencyListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The inspection frequency identifier you use to address it in the
                  API.
                example: freq_fu760equhw69jld
              name:
                type: string
                description: The name of the inspection frequency.
                example: 6-monthly thorough
              interval:
                type: object
                properties:
                  quantity:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: How many units apart inspections fall due.
                    example: 6
                  unit:
                    type: string
                    enum:
                      - days
                      - weeks
                      - months
                      - years
                    description: "`days`, `weeks`, `months` or `years`."
                    example: months
                required:
                  - quantity
                  - unit
                description: How often an inspection falls due.
              type:
                type: string
                enum:
                  - thorough
                  - general
                description: "The kind of inspection that falls due: `thorough` or `general`."
                example: thorough
              status:
                type: string
                enum:
                  - active
                  - paused
                description: "`active`, or `paused` while it raises no new due dates for its
                  items."
                example: active
              created_at:
                type: string
                description: When the inspection frequency was created (ISO 8601).
                example: 2025-01-09T12:00:00.000Z
              updated_at:
                type: string
                description: When the inspection frequency was last changed (ISO 8601).
                example: 2025-01-09T12:00:00.000Z
            required:
              - id
              - name
              - interval
              - type
              - status
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    InspectionFrequencyResponse:
      type: object
      properties:
        id:
          type: string
          description: The inspection frequency identifier you use to address it in the API.
          example: freq_fu760equhw69jld
        name:
          type: string
          description: The name of the inspection frequency.
          example: 6-monthly thorough
        interval:
          type: object
          properties:
            quantity:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: How many units apart inspections fall due.
              example: 6
            unit:
              type: string
              enum:
                - days
                - weeks
                - months
                - years
              description: "`days`, `weeks`, `months` or `years`."
              example: months
          required:
            - quantity
            - unit
          description: How often an inspection falls due.
        type:
          type: string
          enum:
            - thorough
            - general
          description: "The kind of inspection that falls due: `thorough` or `general`."
          example: thorough
        status:
          type: string
          enum:
            - active
            - paused
          description: "`active`, or `paused` while it raises no new due dates for its
            items."
          example: active
        created_at:
          type: string
          description: When the inspection frequency was created (ISO 8601).
          example: 2025-01-09T12:00:00.000Z
        updated_at:
          type: string
          description: When the inspection frequency was last changed (ISO 8601).
          example: 2025-01-09T12:00:00.000Z
      required:
        - id
        - name
        - interval
        - type
        - status
        - created_at
        - updated_at
    InspectionListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The inspection identifier you use to address it in the API.
                example: insp_7igae9yjg93sht5
              item:
                type: object
                properties:
                  id:
                    type: string
                    description: The item identifier (`item_…`).
                    example: item_gdwadfjn13zb7o5
                  serial_number:
                    description: The serial number of the item, if it has one.
                    example: 21H0042871
                    type: string
                    nullable: true
                  name:
                    description: The name you gave the item, if any.
                    example: Harness 12
                    type: string
                    nullable: true
                required:
                  - id
                  - serial_number
                  - name
                description: The item that was inspected.
              status:
                type: string
                enum:
                  - passed
                  - failed
                  - quarantined
                  - monitoring
                description: "The outcome of the inspection: `passed`, `failed`, `quarantined`
                  or `monitoring`."
                example: passed
              type:
                type: string
                enum:
                  - thorough
                  - general
                description: "The kind of inspection: `thorough` or `general`."
                example: thorough
              inspected_at:
                type: string
                description: When the inspection was carried out (ISO 8601), or null if no date
                  was recorded.
                example: 2026-03-02T09:30:00.000Z
                nullable: true
              inspector:
                type: object
                properties:
                  id:
                    description: The member of your organisation who carried it out (`member_…`).
                      Null for someone outside your organisation or who has
                      since left.
                    example: member_tsyqfxifv1te4qf
                    type: string
                    nullable: true
                  name:
                    description: The inspector’s name as recorded with the inspection.
                    example: Tom Fraser
                    type: string
                    nullable: true
                required:
                  - id
                  - name
                description: Who carried out the inspection. Null for a manufacturer’s own
                  inspection, or one recorded without an inspector.
                nullable: true
              is_competent_inspector:
                type: boolean
                description: Whether the inspector was recorded as a competent person for this
                  inspection.
                example: true
              notes:
                description: The notes recorded with the inspection, if any.
                example: Minor wear on the waist belt webbing.
                type: string
                nullable: true
              created_at:
                type: string
                description: When the inspection was recorded (ISO 8601).
                example: 2026-03-02T09:31:00.000Z
              updated_at:
                type: string
                description: When the inspection was last changed (ISO 8601).
                example: 2026-03-02T09:31:00.000Z
            required:
              - id
              - item
              - status
              - type
              - inspected_at
              - inspector
              - is_competent_inspector
              - notes
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    InspectionDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: The inspection identifier you use to address it in the API.
          example: insp_7igae9yjg93sht5
        item:
          type: object
          properties:
            id:
              type: string
              description: The item identifier (`item_…`).
              example: item_gdwadfjn13zb7o5
            serial_number:
              description: The serial number of the item, if it has one.
              example: 21H0042871
              type: string
              nullable: true
            name:
              description: The name you gave the item, if any.
              example: Harness 12
              type: string
              nullable: true
          required:
            - id
            - serial_number
            - name
          description: The item that was inspected.
        status:
          type: string
          enum:
            - passed
            - failed
            - quarantined
            - monitoring
          description: "The outcome of the inspection: `passed`, `failed`, `quarantined`
            or `monitoring`."
          example: passed
        type:
          type: string
          enum:
            - thorough
            - general
          description: "The kind of inspection: `thorough` or `general`."
          example: thorough
        inspected_at:
          type: string
          description: When the inspection was carried out (ISO 8601), or null if no date
            was recorded.
          example: 2026-03-02T09:30:00.000Z
          nullable: true
        inspector:
          type: object
          properties:
            id:
              description: The member of your organisation who carried it out (`member_…`).
                Null for someone outside your organisation or who has since
                left.
              example: member_tsyqfxifv1te4qf
              type: string
              nullable: true
            name:
              description: The inspector’s name as recorded with the inspection.
              example: Tom Fraser
              type: string
              nullable: true
          required:
            - id
            - name
          description: Who carried out the inspection. Null for a manufacturer’s own
            inspection, or one recorded without an inspector.
          nullable: true
        is_competent_inspector:
          type: boolean
          description: Whether the inspector was recorded as a competent person for this
            inspection.
          example: true
        notes:
          description: The notes recorded with the inspection, if any.
          example: Minor wear on the waist belt webbing.
          type: string
          nullable: true
        created_at:
          type: string
          description: When the inspection was recorded (ISO 8601).
          example: 2026-03-02T09:31:00.000Z
        updated_at:
          type: string
          description: When the inspection was last changed (ISO 8601).
          example: 2026-03-02T09:31:00.000Z
        checklist:
          type: object
          properties:
            id:
              type: string
              description: The checklist identifier (`chk_…`). A manufacturer’s checklist
                can’t be retrieved from `/v1/checklists`, but its name and
                results are here.
              example: chk_zsged1q41baxq7s
            name:
              type: string
              description: The name of the checklist.
              example: Harness inspection
          required:
            - id
            - name
          description: The checklist the inspection was made against. Null for an
            inspection made without one.
          nullable: true
        results:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
                description: What was checked.
                example: Webbing free of cuts
              description:
                description: How to check it, if the checklist says.
                example: Check the full length, including under buckles.
                type: string
                nullable: true
              order:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: Its position on the checklist, if it has one.
                example: 1
                nullable: true
              result:
                type: string
                enum:
                  - passed
                  - failed
                  - repair
                  - not_applicable
                  - monitoring
                description: "The result: `passed`, `failed`, `repair`, `not_applicable` or
                  `monitoring`."
                example: passed
              notes:
                description: Notes recorded against this check, if any.
                example: Slightly stiff
                type: string
                nullable: true
            required:
              - title
              - description
              - order
              - result
              - notes
          description: The result of each check on the checklist, in checklist order. Null
            for an inspection made without a checklist.
          nullable: true
        attachments:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - image
                  - pdf
                description: "`image` or `pdf`."
                example: pdf
              name:
                description: The file name, if one was recorded.
                example: Inspection sheet.pdf
                type: string
                nullable: true
              url:
                type: string
                description: Where to download the file. A PDF link stops working at
                  `expires_at`, so download it straight away rather than storing
                  the link.
                example: https://s3.us-west-2.amazonaws.com/scannable-storage/inspections/292dd4ed-79e3-451a-813a-be250dc4f1af.pdf?X-Amz-Expires=3600
              expires_at:
                type: string
                description: When `url` stops working (ISO 8601). Null for an image, whose link
                  does not expire.
                example: 2026-03-02T10:31:00.000Z
                nullable: true
            required:
              - type
              - name
              - url
              - expires_at
          description: The photos and PDFs recorded with the inspection.
      required:
        - id
        - item
        - status
        - type
        - inspected_at
        - inspector
        - is_competent_inspector
        - notes
        - created_at
        - updated_at
        - checklist
        - results
        - attachments
    ChecklistListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The checklist identifier you use to address it in the API.
                example: chk_zsged1q41baxq7s
              name:
                type: string
                description: The name of the checklist.
                example: Harness inspection
              description:
                description: What the checklist is for, if described.
                example: Pre-use and periodic checks for full-body harnesses.
                type: string
                nullable: true
              published:
                type: boolean
                description: Whether the checklist is published for inspectors to use.
                example: true
              created_at:
                type: string
                description: When the checklist was created (ISO 8601).
                example: 2025-01-09T12:00:00.000Z
              updated_at:
                type: string
                description: When the checklist or any of its checks last changed (ISO 8601).
                example: 2026-02-14T16:20:00.000Z
            required:
              - id
              - name
              - description
              - published
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    ChecklistDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: The checklist identifier you use to address it in the API.
          example: chk_zsged1q41baxq7s
        name:
          type: string
          description: The name of the checklist.
          example: Harness inspection
        description:
          description: What the checklist is for, if described.
          example: Pre-use and periodic checks for full-body harnesses.
          type: string
          nullable: true
        published:
          type: boolean
          description: Whether the checklist is published for inspectors to use.
          example: true
        created_at:
          type: string
          description: When the checklist was created (ISO 8601).
          example: 2025-01-09T12:00:00.000Z
        updated_at:
          type: string
          description: When the checklist or any of its checks last changed (ISO 8601).
          example: 2026-02-14T16:20:00.000Z
        criteria:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
                description: What to check.
                example: Webbing free of cuts
              description:
                description: How to check it, if described.
                example: Check the full length, including under buckles.
                type: string
                nullable: true
              order:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: Its position on the checklist, if it has one.
                example: 1
                nullable: true
            required:
              - title
              - description
              - order
          description: The checks on the checklist, in order.
      required:
        - id
        - name
        - description
        - published
        - created_at
        - updated_at
        - criteria
    ExaminationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The examination identifier you use to address it in the API.
                example: exam_u6ff38egif4wibp
              job_reference:
                description: Your job reference for the examination, if you gave one.
                example: JOB-2041
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - active
                  - complete
                description: "`active` while inspections are being added, `complete` once
                  issued."
                example: complete
              issued_at:
                type: string
                description: When the report was issued (ISO 8601), once it has been.
                example: 2026-03-02T09:30:00.000Z
                nullable: true
              inspector:
                description: The name of the competent person who carried it out.
                example: Tom Fraser
                type: string
                nullable: true
              customer:
                description: The customer organisation the examination was for, if any.
                example: Skyline Gondolas
                type: string
                nullable: true
              inspection_count:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: How many inspections the examination holds.
                example: 18
              notes:
                description: Notes recorded with the examination.
                example: Annual thorough examination of the rope access kit.
                type: string
                nullable: true
              created_at:
                type: string
                description: When the examination was started (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
              updated_at:
                type: string
                description: When the examination last changed (ISO 8601).
                example: 2026-03-02T09:30:00.000Z
            required:
              - id
              - job_reference
              - status
              - issued_at
              - inspector
              - customer
              - inspection_count
              - notes
              - created_at
              - updated_at
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The total number of results that match the filters.
          example: 42
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: The page size applied to this response.
          example: 20
        next_cursor:
          description: Pass as `cursor` to fetch the next page. Null on the last page.
          example: eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9
          type: string
          nullable: true
      required:
        - data
        - total
        - limit
        - next_cursor
    ExaminationDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: The examination identifier you use to address it in the API.
          example: exam_u6ff38egif4wibp
        job_reference:
          description: Your job reference for the examination, if you gave one.
          example: JOB-2041
          type: string
          nullable: true
        status:
          type: string
          enum:
            - active
            - complete
          description: "`active` while inspections are being added, `complete` once issued."
          example: complete
        issued_at:
          type: string
          description: When the report was issued (ISO 8601), once it has been.
          example: 2026-03-02T09:30:00.000Z
          nullable: true
        inspector:
          description: The name of the competent person who carried it out.
          example: Tom Fraser
          type: string
          nullable: true
        customer:
          description: The customer organisation the examination was for, if any.
          example: Skyline Gondolas
          type: string
          nullable: true
        inspection_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: How many inspections the examination holds.
          example: 18
        notes:
          description: Notes recorded with the examination.
          example: Annual thorough examination of the rope access kit.
          type: string
          nullable: true
        created_at:
          type: string
          description: When the examination was started (ISO 8601).
          example: 2026-03-02T09:30:00.000Z
        updated_at:
          type: string
          description: When the examination last changed (ISO 8601).
          example: 2026-03-02T09:30:00.000Z
        declaration:
          description: The declaration printed on the report.
          example: The equipment listed is safe to use until the next examination.
          type: string
          nullable: true
      required:
        - id
        - job_reference
        - status
        - issued_at
        - inspector
        - customer
        - inspection_count
        - notes
        - created_at
        - updated_at
        - declaration
