Whitespace

Whitespace Labels API

The Labels API from Whitespace — 3 operation(s) for labels.

GitHub OpenAPI

Operations 5

DELETE /api/labels/{root_or_label_ID} Delete a label from a risk #
GET /api/labels/{root_or_label_ID} Gets an array of labels for the risk #
POST /api/labels/{root_or_label_ID} Adds a label to a risk #
GET /api/labels/suggested A list of frequently used labels to prompt the user§ #
GET /api/labels/teamLabels A list of all labels applied to risks for the team #

Documentation

📖
APIReference
https://swagger.whitespace.co.uk/
📖
Documentation
https://apidocs.whitespace.co.uk/
📖
Documentation
https://apidocs.whitespace.co.uk/Getting_Started_with_the_Whitespace_API.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/Obtaining_and_Using_a_Service_Token_for_the_API.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/Refresh_Token_Guide_v1.0.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/How_does_API_versioning_work.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/An_Introduction_to_Defined_Data.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/Defined%20Data%20API%20and%20JSON%20Notes.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/JMRC%20ACORD%20Specification%20V0.5%20-%20Defined%20Data.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/Queues_and_the_Whitespace_Platform_v1.2.2.pdf
📖
Documentation
https://apidocs.whitespace.co.uk/Integrating_with_Whitespace_via_Queues_3.1.pdf

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/whitespace-london/refs/heads/main/openapi/whitespace-london-labels-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/whitespace-london-labels-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whitespace-london-labels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.1.0
  title: Whitespace Platform Labels API
  description: 'Last update 29th May 2025


    Our intention is to cover the API calls most of use to those wanting to integrate external systems to the Whitespace Platform.'
servers:
- description: Sandbox Environment
  url: https://sandbox.whitespace.co.uk/
- description: Tess Environment
  url: https://tess.whitespace.co.uk/
- description: Beta Environment
  url: https://beta.whitespace.co.uk/
- description: Staging Environment
  url: https://staging.whitespace.co.uk/
security:
- bearerAuth: []
tags:
- name: Labels
paths:
  /api/labels/{root_or_label_ID}:
    delete:
      summary: Delete a label from a risk
      tags:
      - Labels
      parameters:
      - in: path
        name: root_or_label_ID
        schema:
          type: string
        required: true
        description: The full document ID for the label document
        example: IC7B4C4ECF-5340-4A88-B5BE-A4ECE8859B61::LBL::BLACKROBOT::AUTOAPIJENKINS201021::High-Priority::2021-11-23::08:36:55
      responses:
        '200':
          description: A confirmation of the deletion
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                    description: true if the label was deleted
                  id:
                    type: string
                    description: The full document ID for the label document
                    example: IC7B4C4ECF-5340-4A88-B5BE-A4ECE8859B61::LBL::BLACKROBOT::AUTOAPIJENKINS201021::High-Priority::2021-11-23::08:36:55
                  rev:
                    type: string
                    description: the revision for the document
                    example: 2-4412b4f96247795da30b19250bbf5e00
      operationId: deleteApiLabelsByRootOrLabelID
      x-operation-id-source: derived
    get:
      summary: Gets an array of labels for the risk
      tags:
      - Labels
      parameters:
      - in: path
        name: root_or_label_ID
        schema:
          type: string
        required: true
        description: The first part of the riskID, starting IC and stopping before any '::' delimiters. NEW in 2.20 - You can not add the same label multiple times on the same risk.
        example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57
      responses:
        '200':
          description: An array of label documents for the risk
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RWLabel'
      operationId: getApiLabelsByRootOrLabelID
      x-operation-id-source: derived
    post:
      summary: Adds a label to a risk
      description: The payload covers the label text and team
      tags:
      - Labels
      parameters:
      - in: path
        name: root_or_label_ID
        schema:
          type: string
        required: true
        description: The first part of the riskID, starting IC and stopping before any '::' delimiters
        example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                channel:
                  description: the team channel for the label
                  example: carrier_MARINECASUALTY
                  type: string
                title:
                  description: the text of the label
                  example: High Priority
                  type: string
      responses:
        '200':
          description: Response for adding a label succesfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: the document ID for the added label
                    example: IC7B4C4ECF-5340-4A88-B5BE-A4ECE8859B61::LBL::BLACKROBOT::AUTOAPIJENKINS201021::High-Priority::2021-11-23::08:36:55
                  rev:
                    type: string
                    description: the revision for the document
                    example: 1-9eb01c8b711503293b57aafa63aa70c4
                  ok:
                    type: boolean
                    description: true if the labels was saved
                    example: true
      operationId: postApiLabelsByRootOrLabelID
      x-operation-id-source: derived
  /api/labels/suggested:
    get:
      summary: A list of frequently used labels to prompt the user§
      tags:
      - Labels
      responses:
        '200':
          description: array of label strings
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  example: High Priority
      operationId: getApiLabelsSuggested
      x-operation-id-source: derived
  /api/labels/teamLabels:
    get:
      summary: A list of all labels applied to risks for the team
      tags:
      - Labels
      responses:
        '200':
          description: An array of label documents across multiple risk
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RWLabel'
      operationId: getApiLabelsTeamLabels
      x-operation-id-source: derived
components:
  schemas:
    RWLabel:
      type: object
      properties:
        _id:
          type: string
          description: the unique id of the label document
          example: IC7B4C4ECF-5340-4A88-B5BE-A4ECE8859B61::LBL::BLACKROBOT::AUTOAPIJENKINS201021::High-Priority::2021-11-23::08:36:55
        _rev:
          type: string
          description: the revision number of the document
          example: 1-9eb01c8b711503293b57aafa63aa70c4
        channels:
          type: array
          items:
            type: string
            description: channels for teams able to see the document
            example: carrier_MARINECASUALTY
        companyID:
          type: string
          description: the ID of the company
          example: BLACKROBOT
        createdAt:
          type: string
          description: the date and time the document was created
          example: '2021-11-23 08:36:55'
        rootID:
          type: string
          description: the rootID of the related risk
          example: IC7B4C4ECF-5340-4A88-B5BE-A4ECE8859B61
        teamID:
          type: string
          description: the ID of the team
          example: AUTOAPIJENKINS201021
        title:
          type: string
          description: the text of the label
          example: High Priority
        type:
          type: string
          description: the type of document
          example: RWLabel
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT