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

# Create Organization



## OpenAPI

````yaml /api-reference/preview.json post /gb/organizations
openapi: 3.2.0
info:
  description: Intermezzo's global payroll apis, organized by country
  summary: Global Payroll Platform
  title: Intermezzo Global Payroll
  version: '2026-11-18'
  x-logo:
    url: /static/icon.svg
servers:
  - description: Preview
    url: https://preview.intermezzo.ai
security: []
paths:
  /gb/organizations:
    post:
      tags:
        - Great Britain
        - Organizations
      summary: Create Organization
      operationId: gb_organization_create
      parameters:
        - description: >-
            The person acting through the access credential, recorded as
            `created_by` of what the request writes. Audit only: access is
            checked on the credential.
          in: header
          name: X-Acting-User
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                type: string
              - type: 'null'
            description: >-
              The person acting through the access credential, recorded as
              `created_by` of what the request writes. Audit only: access is
              checked on the credential.
            title: X-Acting-User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GBOrganizationCreateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GBOrganizationResponse'
          description: Successful Response
        '409':
          content:
            application/json:
              examples:
                HUB_DUPLICATE_EXTERNAL_REF:
                  summary: >-
                    Raised when the parent already has a hub with this
                    external_ref.
                  value:
                    errors:
                      - code: HUB_DUPLICATE_EXTERNAL_REF
                        message: >-
                          Raised when the parent already has a hub with this
                          external_ref.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - HUB_DUPLICATE_EXTERNAL_REF
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `HUB_DUPLICATE_EXTERNAL_REF`: Raised when the parent already has a
            hub with this external_ref.
        '422':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - FIELD_REQUIRED
                            - FIELD_INVALID_TYPE_STRING
                            - FIELD_INVALID_TYPE_INT
                            - FIELD_INVALID_TYPE_FLOAT
                            - FIELD_INVALID_TYPE_BOOL
                            - FIELD_INVALID_TYPE_DICT
                            - FIELD_INVALID_TYPE_LIST
                            - FIELD_STRING_TOO_SHORT
                            - FIELD_STRING_TOO_LONG
                            - FIELD_STRING_PATTERN_MISMATCH
                            - FIELD_VALUE_TOO_SMALL
                            - FIELD_VALUE_TOO_LARGE
                            - FIELD_INVALID_DATE
                            - FIELD_INVALID_DATETIME
                            - FIELD_INVALID_TIME
                            - FIELD_INVALID_DATE_FORMAT
                            - FIELD_INVALID_DATETIME_FORMAT
                            - FIELD_INVALID_ENUM_VALUE
                            - FIELD_INVALID_EMAIL
                            - FIELD_INVALID_URL
                            - FIELD_LIST_TOO_SHORT
                            - FIELD_LIST_TOO_LONG
                            - FIELD_UNKNOWN
                            - FIELD_VALIDATION_ERROR
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            The request failed validation. Type and format errors use the
            generic FIELD_* codes.
      security:
        - BearerToken: []
components:
  schemas:
    GBOrganizationCreateRequest:
      additionalProperties: false
      description: >-
        Creating an organization: the hub, `valid_from`, `core`, and any other

        satellites. Each satellite sent starts on `[valid_from, 9999-12-31)`.
        One not sent is

        not created: it reads as null until a PUT writes it.
      properties:
        address:
          $ref: '#/components/schemas/GBOrganizationAddress'
        bank:
          $ref: '#/components/schemas/GBOrganizationBank'
        contact:
          $ref: '#/components/schemas/GBOrganizationContact'
        core:
          $ref: '#/components/schemas/GBOrganizationCore'
        external_ref:
          description: >-
            The integrator's own key, unique within the parent and never
            changed. A path may name the hub as `ext:{external_ref}`.
          maxLength: 255
          minLength: 1
          pattern: ^[A-Za-z0-9._~-]+$
          title: External Ref
          type: string
        insurance:
          $ref: '#/components/schemas/GBOrganizationInsurance'
        tax:
          $ref: '#/components/schemas/GBOrganizationTax'
        valid_from:
          description: The first day every satellite's data is valid at
          format: date
          title: Valid From
          type: string
      required:
        - valid_from
        - core
      title: GBOrganizationCreateRequest
      type: object
    GBOrganizationResponse:
      additionalProperties: false
      description: >-
        The organization with every satellite as it reads on one date. A
        satellite never

        written, or with no slice on an explicit date, is null.
      properties:
        address:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationAddressSatellite'
            - type: 'null'
        bank:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationBankSatellite'
            - type: 'null'
        client_id:
          readOnly: true
          title: Client Id
          type: string
        contact:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationContactSatellite'
            - type: 'null'
        core:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationCoreSatellite'
            - type: 'null'
        country_code:
          const: GB
          readOnly: true
          title: Country Code
          type: string
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who created the hub: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        deleted_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the hub was closed
          readOnly: true
          title: Deleted At
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        id:
          title: Id
          type: string
        insurance:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationInsuranceSatellite'
            - type: 'null'
        status:
          $ref: '#/components/schemas/GBOrganizationStatus'
        tax:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationTaxSatellite'
            - type: 'null'
      required:
        - id
        - external_ref
        - created_at
        - created_by
        - deleted_at
        - client_id
        - country_code
        - status
      title: GBOrganizationResponse
      type: object
    GBOrganizationAddress:
      additionalProperties: false
      properties:
        address:
          $ref: '#/components/schemas/GBOrganizationUKAddress'
          description: The registered address
        correspondence_address:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationUKAddress'
            - type: 'null'
          description: Where post goes when not the registered address; null when the same
      required:
        - address
        - correspondence_address
      title: GBOrganizationAddress
      type: object
    GBOrganizationBank:
      additionalProperties: false
      properties:
        accounts:
          description: Accounts; empty when none
          items:
            $ref: '#/components/schemas/GBOrganizationBankAccount'
          title: Accounts
          type: array
        bacs_service_user_number:
          anyOf:
            - pattern: ^\d{6}$
              type: string
            - type: 'null'
          description: >-
            BACS Service User Number the net pay file is submitted under; null
            when the organization does not pay by BACS
          examples:
            - '123456'
          title: Bacs Service User Number
      required:
        - accounts
        - bacs_service_user_number
      title: GBOrganizationBank
      type: object
    GBOrganizationContact:
      additionalProperties: false
      properties:
        contacts:
          description: Contacts; empty when none
          items:
            $ref: '#/components/schemas/GBOrganizationContactEntry'
          title: Contacts
          type: array
        hmrc_sender_email:
          anyOf:
            - format: email
              type: string
            - type: 'null'
          description: >-
            Where HMRC writes to the sender about the employer's filings; null
            when none
          examples:
            - payroll@acme.example
          title: Hmrc Sender Email
      required:
        - contacts
        - hmrc_sender_email
      title: GBOrganizationContact
      type: object
    GBOrganizationCore:
      additionalProperties: false
      properties:
        dba_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          description: The trading name; null when none
          examples:
            - Acme
          title: Dba Name
        incorporation_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Null when not incorporated
          title: Incorporation Date
        legal_name:
          description: The registered name, as filed to HMRC
          examples:
            - Acme Trading Ltd
          maxLength: 35
          minLength: 1
          title: Legal Name
          type: string
        logo_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The logo printed on payslips, an uploaded organization logo
            document; null when none
          title: Logo Id
        shutdown_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The day the employer ceased trading; null while it trades
          title: Shutdown Date
        website:
          anyOf:
            - type: string
            - type: 'null'
          examples:
            - https://acme.example/
          title: Website
      required:
        - legal_name
        - dba_name
        - incorporation_date
        - website
        - shutdown_date
        - logo_id
      title: GBOrganizationCore
      type: object
    GBOrganizationInsurance:
      additionalProperties: false
      properties:
        employment_allowance_eligible:
          description: >-
            Claims the Employment Allowance against its employer National
            Insurance; the amount is the statutory one of the tax year
          title: Employment Allowance Eligible
          type: boolean
      required:
        - employment_allowance_eligible
      title: GBOrganizationInsurance
      type: object
    GBOrganizationTax:
      additionalProperties: false
      properties:
        accounts_office_reference:
          examples:
            - 123PA00012345
          pattern: ^\d{3}P[a-zA-Z](\d{8}|\d{7}X)$
          title: Accounts Office Reference
          type: string
        corporation_tax_reference:
          anyOf:
            - pattern: ^\d{10}$
              type: string
            - type: 'null'
          description: Null when none
          examples:
            - '1234567890'
          title: Corporation Tax Reference
        paye_reference_number:
          description: 'Employer PAYE reference: tax office number / reference'
          examples:
            - 123/AB456
          pattern: ^\d{3}/[a-zA-Z0-9]{1,10}$
          title: Paye Reference Number
          type: string
      required:
        - paye_reference_number
        - accounts_office_reference
        - corporation_tax_reference
      title: GBOrganizationTax
      type: object
    GBOrganizationAddressSatellite:
      additionalProperties: false
      properties:
        address:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationUKAddressRead'
            - type: 'null'
        correspondence_address:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationUKAddressRead'
            - type: 'null'
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationAddressSatellite
      type: object
    GBOrganizationBankSatellite:
      additionalProperties: false
      properties:
        accounts:
          items:
            $ref: '#/components/schemas/GBOrganizationBankAccountRead'
          title: Accounts
          type: array
        bacs_service_user_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Bacs Service User Number
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationBankSatellite
      type: object
    GBOrganizationContactSatellite:
      additionalProperties: false
      properties:
        contacts:
          items:
            $ref: '#/components/schemas/GBOrganizationContactEntryRead'
          title: Contacts
          type: array
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        hmrc_sender_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Hmrc Sender Email
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationContactSatellite
      type: object
    GBOrganizationCoreSatellite:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        dba_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Dba Name
        edition:
          readOnly: true
          title: Edition
          type: integer
        incorporation_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Incorporation Date
        legal_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Legal Name
        logo_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Id
        shutdown_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Shutdown Date
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
        website:
          anyOf:
            - type: string
            - type: 'null'
          title: Website
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationCoreSatellite
      type: object
    GBOrganizationInsuranceSatellite:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        employment_allowance_eligible:
          default: false
          title: Employment Allowance Eligible
          type: boolean
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationInsuranceSatellite
      type: object
    GBOrganizationStatus:
      additionalProperties: false
      description: >-
        The read-only status satellite. It carries no fields; it exists so that
        every

        organization read has a `status` object.
      properties: {}
      title: GBOrganizationStatus
      type: object
    GBOrganizationTaxSatellite:
      additionalProperties: false
      properties:
        accounts_office_reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Accounts Office Reference
        corporation_tax_reference:
          anyOf:
            - type: string
            - type: 'null'
          title: Corporation Tax Reference
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        paye_reference_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Paye Reference Number
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationTaxSatellite
      type: object
    GBOrganizationUKAddress:
      additionalProperties: false
      description: A UK, Jersey, Guernsey or Isle of Man address, as filed.
      properties:
        address_line_1:
          description: First address line
          examples:
            - 1 Main Street
          maxLength: 35
          minLength: 1
          title: Address Line 1
          type: string
        address_line_2:
          description: Second address line
          examples:
            - Floor 2
          maxLength: 35
          minLength: 1
          title: Address Line 2
          type: string
        address_line_3:
          anyOf:
            - maxLength: 35
              minLength: 1
              type: string
            - type: 'null'
          description: Third address line; null when none
          title: Address Line 3
        address_line_4:
          anyOf:
            - maxLength: 35
              minLength: 1
              type: string
            - type: 'null'
          description: Fourth address line; null when none
          title: Address Line 4
        country:
          description: 'Country, ISO 3166-1 alpha-2 code: GB, JE, GG or IM'
          enum:
            - GB
            - JE
            - GG
            - IM
          examples:
            - GB
          title: Country
          type: string
        county:
          anyOf:
            - maxLength: 35
              minLength: 1
              type: string
            - type: 'null'
          description: County, at most 35 characters, as an address line; null when none
          title: County
        postcode:
          description: UK postcode, stored in canonical form (`EC1A 1BB`)
          examples:
            - EC1A 1BB
          title: Postcode
          type: string
        town:
          description: Town or city, at most 35 characters, as an address line
          examples:
            - London
          maxLength: 35
          minLength: 1
          title: Town
          type: string
      required:
        - address_line_1
        - address_line_2
        - address_line_3
        - address_line_4
        - town
        - county
        - postcode
        - country
      title: GBOrganizationUKAddress
      type: object
    GBOrganizationBankAccount:
      additionalProperties: false
      description: A UK account the employer pays from by BACS.
      properties:
        account_number:
          examples:
            - '31926819'
          pattern: ^\d{8}$
          title: Account Number
          type: string
        financial_institution_name:
          anyOf:
            - type: string
            - type: 'null'
          examples:
            - Lloyds Bank
          title: Financial Institution Name
        is_active:
          description: Inactive accounts are not paid from
          title: Is Active
          type: boolean
        is_primary:
          description: The account BACS payments are debited from
          title: Is Primary
          type: boolean
        sort_code:
          description: Six digits; dashes and spaces are removed.
          examples:
            - '200015'
          title: Sort Code
          type: string
      required:
        - account_number
        - sort_code
        - financial_institution_name
        - is_primary
        - is_active
      title: GBOrganizationBankAccount
      type: object
    GBOrganizationContactEntry:
      additionalProperties: false
      properties:
        email:
          anyOf:
            - format: email
              type: string
            - type: 'null'
          examples:
            - payroll@acme.example
          title: Email
        is_primary:
          description: The first contact authorities are given
          title: Is Primary
          type: boolean
        name:
          examples:
            - Jane Smith
          minLength: 1
          title: Name
          type: string
        phone:
          anyOf:
            - $ref: '#/components/schemas/ContactPhoneNumber'
            - type: 'null'
        roles:
          description: What the contact is for; empty when unspecified
          items:
            type: string
          title: Roles
          type: array
      required:
        - name
        - email
        - phone
        - roles
        - is_primary
      title: GBOrganizationContactEntry
      type: object
    GBOrganizationUKAddressRead:
      additionalProperties: false
      description: The address as stored; every field is nullable.
      properties:
        address_line_1:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line 1
        address_line_2:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line 2
        address_line_3:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line 3
        address_line_4:
          anyOf:
            - type: string
            - type: 'null'
          title: Address Line 4
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        county:
          anyOf:
            - type: string
            - type: 'null'
          title: County
        postcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Postcode
        town:
          anyOf:
            - type: string
            - type: 'null'
          title: Town
      title: GBOrganizationUKAddressRead
      type: object
    GBOrganizationBankAccountRead:
      additionalProperties: false
      description: >-
        An account as stored. Accounts moved from before the bank satellite were
        not

        checked against the UK formats, so a read does not check them either.
      properties:
        account_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Number
        financial_institution_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Financial Institution Name
        is_active:
          default: true
          title: Is Active
          type: boolean
        is_primary:
          default: false
          title: Is Primary
          type: boolean
        sort_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Sort Code
      title: GBOrganizationBankAccountRead
      type: object
    GBOrganizationContactEntryRead:
      additionalProperties: false
      properties:
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        is_primary:
          default: false
          title: Is Primary
          type: boolean
        name:
          examples:
            - Jane Smith
          minLength: 1
          title: Name
          type: string
        phone:
          anyOf:
            - $ref: '#/components/schemas/ContactPhoneNumber'
            - type: 'null'
        roles:
          items:
            type: string
          title: Roles
          type: array
      required:
        - name
      title: GBOrganizationContactEntryRead
      type: object
    ContactPhoneNumber:
      additionalProperties: false
      properties:
        phone_number:
          format: phone
          title: Phone Number
          type: string
        phone_type:
          $ref: '#/components/schemas/PhoneType'
      required:
        - phone_number
        - phone_type
      title: ContactPhoneNumber
      type: object
    PhoneType:
      enum:
        - MOBILE
        - HOME
        - WORK
      title: PhoneType
      type: string
  securitySchemes:
    BearerToken:
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here
      scheme: bearer
      type: http

````

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