> ## 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.

# List Organizations

> Each item is a summary: the organization hub with its `core`, `tax` satellites. Get one by id for every satellite.



## OpenAPI

````yaml /api-reference/preview.json get /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:
    get:
      tags:
        - Great Britain
        - Organizations
      summary: List Organizations
      description: >-
        Each item is a summary: the organization hub with its `core`, `tax`
        satellites. Get one by id for every satellite.
      operationId: gb_organization_list
      parameters:
        - description: >-
            Valid-time date to read, past or future. Defaults to today, or to
            the first upcoming edition when nothing is valid yet.
          in: query
          name: valid_at
          required: false
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            description: >-
              Valid-time date to read, past or future. Defaults to today, or to
              the first upcoming edition when nothing is valid yet.
            title: Valid At
        - description: Items per page
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: Items per page
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: '`next_cursor` of the previous response, for the next page'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: '`next_cursor` of the previous response, for the next page'
            title: Cursor
        - description: >-
            `prev_cursor` of the previous response, for the page before it. Not
            together with `cursor`.
          in: query
          name: prev_cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              `prev_cursor` of the previous response, for the page before it.
              Not together with `cursor`.
            title: Prev Cursor
        - description: >-
            Fields to order by, `-` in front for descending (`-created_at`).
            Repeat the parameter for more fields. Keep the same sort while
            following cursors.
          in: query
          name: sort
          required: false
          schema:
            default:
              - id
            description: >-
              Fields to order by, `-` in front for descending (`-created_at`).
              Repeat the parameter for more fields. Keep the same sort while
              following cursors.
            items:
              type: string
            title: Sort
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_GBOrganizationSummary_'
          description: Successful Response
        '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:
    PaginatedResponse_GBOrganizationSummary_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GBOrganizationSummary'
          title: Items
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - items
        - pagination
      title: PaginatedResponse[GBOrganizationSummary]
      type: object
    GBOrganizationSummary:
      additionalProperties: false
      description: >-
        An organization in a list: the hub and its core and tax satellites as
        they read on

        the date of the list. A satellite never written, or with no slice on an
        explicit

        date, is null.
      properties:
        client_id:
          readOnly: true
          title: Client Id
          type: string
        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
        tax:
          anyOf:
            - $ref: '#/components/schemas/GBOrganizationTaxSatellite'
            - type: 'null'
      required:
        - id
        - external_ref
        - created_at
        - created_by
        - deleted_at
        - client_id
        - country_code
      title: GBOrganizationSummary
      type: object
    PaginationMeta:
      additionalProperties: false
      properties:
        has_next:
          default: false
          description: A page follows; fetch it with `next_cursor`
          title: Has Next
          type: boolean
        has_prev:
          default: false
          description: A page precedes; fetch it with `prev_cursor`
          title: Has Prev
          type: boolean
        limit:
          description: Items per page, as requested
          title: Limit
          type: integer
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Pass as `cursor` to get the next page; null on the last page
          title: Next Cursor
        prev_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Pass as `prev_cursor` to get the previous page; null on the first
            page
          title: Prev Cursor
        total:
          default: 0
          description: Number of items across all pages
          title: Total
          type: integer
      required:
        - limit
      title: PaginationMeta
      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
    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
  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.