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

# Create a supplier in the accounting system

> Creates this supplier of ours in the accounting system the company's invoices are sent to, and links it: the one way Watchdog adds a supplier there, since sending an invoice never does (its invoices wait in Inbox as supplier_not_in_erp until it is created or linked). Created with the connection's key from what missing_link.proposal shows (our supplier's name, Norwegian organization number and postal address), with any name or address the request sends instead, and the Norwegian bank account it sends (bank_account), which goes on its card there; without one its invoices are saved to pay later until a person adds it there. The create and the account are recorded in the organization's activity. Looks there first: the one active supplier there with its organization number is linked instead, with the accounts its card holds, and the link is recorded in the activity. Returns its links, with missing_link for the company. Refused (409, a code per reason, saying what to do instead) when one there has its name but no organization number, several have its number or the one with it is inactive (link it with linkErpSupplier), when it has no Norwegian organization number, when the company's invoices are sent nowhere, or when the accounting system or the connection's access to it cannot create it now. Nothing changes when it is linked there already, or when the register already holds the one active supplier with its number, which the send links.



## OpenAPI

````yaml /openapi.json post /v1/parties/{id}/erp-links/create
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/parties/{id}/erp-links/create:
    post:
      tags:
        - Suppliers and recipients
      summary: Create a supplier in the accounting system
      description: >-
        Creates this supplier of ours in the accounting system the company's
        invoices are sent to, and links it: the one way Watchdog adds a supplier
        there, since sending an invoice never does (its invoices wait in Inbox
        as supplier_not_in_erp until it is created or linked). Created with the
        connection's key from what missing_link.proposal shows (our supplier's
        name, Norwegian organization number and postal address), with any name
        or address the request sends instead, and the Norwegian bank account it
        sends (bank_account), which goes on its card there; without one its
        invoices are saved to pay later until a person adds it there. The create
        and the account are recorded in the organization's activity. Looks there
        first: the one active supplier there with its organization number is
        linked instead, with the accounts its card holds, and the link is
        recorded in the activity. Returns its links, with missing_link for the
        company. Refused (409, a code per reason, saying what to do instead)
        when one there has its name but no organization number, several have its
        number or the one with it is inactive (link it with linkErpSupplier),
        when it has no Norwegian organization number, when the company's
        invoices are sent nowhere, or when the accounting system or the
        connection's access to it cannot create it now. Nothing changes when it
        is linked there already, or when the register already holds the one
        active supplier with its number, which the send links.
      operationId: createErpSupplier
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateErpSupplier'
      responses:
        '200':
          description: The supplier's links.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErpSupplier'
                  missing_link:
                    $ref: '#/components/schemas/MissingErpLink'
                required:
                  - data
                  - missing_link
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_validation_error'
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
        '404':
          description: The resource does not exist in the current organization.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: not_found
                  message: The resource does not exist in the current organization.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_not_found'
        '409':
          description: >-
            The supplier cannot be created there; the message says what to do
            instead. erp_supplier_may_exist: one there may be it (its name
            without a number, several with its number, an inactive one, or one
            linked to another supplier), so link it.
            erp_supplier_org_number_required: it has no Norwegian organization
            number. erp_supplier_create_not_allowed: the connection's access
            there may not add suppliers. erp_supplier_rejected: the accounting
            system did not take it as sent (its name or address), so check them,
            or add it there and link it. erp_supplier_created_unlinked: it was
            created there, but our supplier was linked to another one there
            meanwhile, so check its links. erp_access_rejected: the accounting
            system rejected the connection's credentials. erp_sending_off: the
            company sends invoices nowhere, or the connection is turned off.
            erp_unavailable: the accounting system cannot be asked now.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: erp_supplier_may_exist
                  message: >-
                    The supplier cannot be created there; the message says what
                    to do instead. erp_supplier_may_exist: one there may be it
                    (its name without a number, several with its number, an
                    inactive one, or one linked to another supplier), so link
                    it. erp_supplier_org_number_required: it has no Norwegian
                    organization number. erp_supplier_create_not_allowed: the
                    connection's access there may not add suppliers.
                    erp_supplier_rejected: the accounting system did not take it
                    as sent (its name or address), so check them, or add it
                    there and link it. erp_supplier_created_unlinked: it was
                    created there, but our supplier was linked to another one
                    there meanwhile, so check its links. erp_access_rejected:
                    the accounting system rejected the connection's credentials.
                    erp_sending_off: the company sends invoices nowhere, or the
                    connection is turned off. erp_unavailable: the accounting
                    system cannot be asked now.
                  request_id: req_example
              schema:
                $ref: >-
                  #/components/schemas/Error_erp_supplier_may_exist_erp_supplier_org_number_required_erp_supplier_create_not_allowed_erp_supplier_rejected_erp_supplier_created_unlinked_erp_access_rejected_erp_sending_off_erp_unavailable
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_internal_error'
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    CreateErpSupplier:
      type: object
      properties:
        company_id:
          type: string
          format: uuid
          description: >-
            The workspace company whose accounting system the supplier is
            created in: the one that company's invoices are sent to.
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: The name it gets there. Left out, our supplier's name.
        street:
          type:
            - string
            - 'null'
          maxLength: 255
          description: Its postal address there. Left out, our supplier's; null sends none.
        postal_code:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Left out, our supplier's; null sends none.
        city:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Left out, our supplier's; null sends none.
        country:
          type:
            - string
            - 'null'
          pattern: ^[A-Za-z]{2}$
          description: >-
            The address's country, ISO 3166-1 alpha-2. Left out, our supplier's
            (Norway without one); null sends none.
        bank_account:
          type:
            - string
            - 'null'
          maxLength: 50
          description: >-
            The bank account put on its card there, as the person checked it
            (the app proposes the invoice's): a Norwegian account, 11 digits or
            its NO IBAN. Left out or null, none, and the send saves its invoices
            to pay later until one is on the card.
      required:
        - company_id
      additionalProperties: false
    ErpSupplier:
      type: object
      properties:
        source_system:
          type: string
          description: The accounting system.
        number:
          type:
            - string
            - 'null'
          description: The supplier number people see there.
        name:
          type: string
        organization_number:
          type:
            - string
            - 'null'
        active:
          type: boolean
        removed:
          type: boolean
          description: The accounting system no longer has it.
        linked_supplier:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          required:
            - id
            - name
          description: Our supplier it is linked to.
        companies:
          type: array
          items:
            type: object
            properties:
              company_id:
                type: string
                format: uuid
                description: >-
                  The workspace company whose accounting system's register it is
                  in.
              id:
                type: string
                format: uuid
                description: 'The register entry: an erp_supplier_id to link.'
              supplier_id_in_system:
                type: string
                description: >-
                  The accounting system's own ID for the supplier, which
                  vouchers are sent to.
              connection:
                type:
                  - object
                  - 'null'
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                required:
                  - id
                  - name
                description: The connection that read it last; null once deleted.
              linked_by:
                type:
                  - string
                  - 'null'
                enum:
                  - org_number
                  - vat_number
                  - transfer_lookup
                  - created
                  - manual
                  - null
                description: >-
                  org_number or vat_number: the only supplier of ours with its
                  number. transfer_lookup: found by its organization number when
                  an invoice was sent or a person created it. created: a person
                  created it there from Watchdog (createErpSupplier), or a send
                  did before sends stopped creating suppliers. manual: a person
                  linked or unlinked it, and no rule changes it.
              linked_at:
                type:
                  - string
                  - 'null'
                format: date-time
            required:
              - company_id
              - id
              - supplier_id_in_system
              - connection
              - linked_by
              - linked_at
          minItems: 1
          description: >-
            Each company whose register has it, with its own entry: what several
            companies' registers have alike, linked to the same supplier of
            ours, is one row.
      required:
        - source_system
        - number
        - name
        - organization_number
        - active
        - removed
        - linked_supplier
        - companies
    MissingErpLink:
      type:
        - object
        - 'null'
      properties:
        integration_id:
          type: string
          format: uuid
          description: The connection that sends invoices.
        system_name:
          type: string
        status:
          type: string
          enum:
            - can_create
            - no_org_number
            - ambiguous
            - inactive
            - same_name
        proposal:
          type:
            - object
            - 'null'
          properties:
            name:
              type: string
            organization_number:
              type: string
            street:
              type:
                - string
                - 'null'
            postal_code:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            country:
              type:
                - string
                - 'null'
              description: ISO 3166-1 alpha-2.
          required:
            - name
            - organization_number
            - street
            - postal_code
            - city
            - country
          description: >-
            What createErpSupplier sends when called without changes: our
            supplier's name, its Norwegian organization number and its postal
            address. The name and address can be changed in the create, and a
            bank account added (bank_account); the organization number cannot
            change, as it ties the supplier there to ours. Null unless status is
            can_create.
      required:
        - integration_id
        - system_name
        - status
        - proposal
      description: >-
        Set while the connection that sends invoices has no link for the
        supplier and holds no one active supplier with its organization number
        for sending to link. Its invoices are then held in Inbox
        (supplier_not_in_erp) and not sent until someone creates or links it:
        Watchdog never creates a supplier there on its own. can_create:
        createErpSupplier creates it there from its name, Norwegian organization
        number and address, and links it. Otherwise someone links it to an entry
        of that connection's register (linkErpSupplier), or adds it there:
        no_org_number (no Norwegian organization number, so Watchdog does not
        create it), same_name (one there has its name but no organization
        number), ambiguous (several there have its number), inactive (the one
        with its number is inactive there). From the register as last synced; a
        create looks there again. Null when no connection sends invoices.
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_not_found:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_erp_supplier_may_exist_erp_supplier_org_number_required_erp_supplier_create_not_allowed_erp_supplier_rejected_erp_supplier_created_unlinked_erp_access_rejected_erp_sending_off_erp_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - erp_supplier_may_exist
                - erp_supplier_org_number_required
                - erp_supplier_create_not_allowed
                - erp_supplier_rejected
                - erp_supplier_created_unlinked
                - erp_access_rejected
                - erp_sending_off
                - erp_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

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