> ## 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 Catalog Wage Types

> The country catalog's wage types, each with its `core` and `lifecycle` as they read on `valid_at`. An organization resolves a code against its own types first, then against these.



## OpenAPI

````yaml /api-reference/preview.json get /gb/wage-types
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/wage-types:
    get:
      tags:
        - Great Britain
        - Wage Types
      summary: List Catalog Wage Types
      description: >-
        The country catalog's wage types, each with its `core` and `lifecycle`
        as they read on `valid_at`. An organization resolves a code against its
        own types first, then against these.
      operationId: gb_catalog_wage_type_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_GBWageTypeSummary_'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerToken: []
components:
  schemas:
    PaginatedResponse_GBWageTypeSummary_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GBWageTypeSummary'
          title: Items
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - items
        - pagination
      title: PaginatedResponse[GBWageTypeSummary]
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GBWageTypeSummary:
      additionalProperties: false
      description: >-
        A wage type in a list: the hub with its core and lifecycle as they read
        on the

        date of the list.
      properties:
        core:
          anyOf:
            - $ref: '#/components/schemas/GBWageTypeCoreSatellite'
            - type: 'null'
        country_code:
          $ref: '#/components/schemas/CountryCode'
        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
        lifecycle:
          anyOf:
            - $ref: '#/components/schemas/WageTypeLifecycleSatellite'
            - type: 'null'
        organization_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The owning organization; null for the country catalog's own types
          title: Organization Id
        system_usage:
          anyOf:
            - $ref: '#/components/schemas/WageTypeSystemUsage'
            - type: 'null'
          description: >-
            On catalog types: how an organization may use it, e.g. as an input,
            or not submit it at all because the engine calculates it
        wage_type_code:
          description: Business key, unique within its owner
          title: Wage Type Code
          type: string
      required:
        - id
        - external_ref
        - created_at
        - created_by
        - deleted_at
        - organization_id
        - country_code
        - wage_type_code
        - system_usage
      title: GBWageTypeSummary
      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
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    GBWageTypeCoreSatellite:
      additionalProperties: false
      properties:
        category:
          $ref: '#/components/schemas/GBWageTypeCategory'
          description: Wage type category
        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
        description:
          description: Description of the wage type
          title: Description
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        name:
          description: Display name
          title: Name
          type: string
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - name
        - description
        - category
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBWageTypeCoreSatellite
      type: object
    CountryCode:
      description: Enum for CountryAlpha2 codes
      enum:
        - IE
        - GB
        - AE
        - US
      title: CountryCode
      type: string
    WageTypeLifecycleSatellite:
      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
        state:
          $ref: '#/components/schemas/WageTypeState'
          description: Lifecycle state
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - state
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: WageTypeLifecycleSatellite
      type: object
    WageTypeSystemUsage:
      description: >-
        How a catalog (platform-owned) wage type may be used by organizations.


        Set only on catalog rows (organization_id IS NULL); NULL on an
        organization's rows.
      enum:
        - DERIVABLE
        - CALCULATED_ONLY
        - NON_DERIVABLE
        - TERMINATION
      title: WageTypeSystemUsage
      type: string
    GBWageTypeCategory:
      description: Category of GB wage type.
      enum:
        - EARNINGS
        - DEDUCTIONS
        - BENEFITS
        - STATUTORY
        - PENSION
        - CONTRIBUTIONS
        - ADJUSTMENTS
        - REIMBURSEMENTS
      title: GBWageTypeCategory
      type: string
    WageTypeState:
      description: >-
        Lifecycle state of a wage type (the `state` of its `lifecycle`
        satellite).
      enum:
        - DRAFT
        - APPROVED
        - DEPRECATED
      title: WageTypeState
      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.