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

# List all compensations

> Returns a paginated list of compensations for the authenticated company.



## OpenAPI

````yaml GET /contract/v1/compensations
openapi: 3.0.0
info:
  description: ''
  version: 3.0.0
  title: Sesame Public API
servers:
  - url: https://api-{region}.sesametime.com
    variables:
      region:
        default: eu1
security: []
tags: []
paths:
  /contract/v1/compensations:
    get:
      tags:
        - Compensations
      summary: List all compensations
      description: Returns a paginated list of compensations for the authenticated company.
      operationId: ListCompensations
      parameters:
        - name: name
          in: query
          description: Filter by name (contains)
          schema:
            type: string
        - name: compensationType
          in: query
          description: Filter by compensation type
          schema:
            type: string
            enum:
              - fixed
              - variable
              - additional
        - name: period
          in: query
          description: Filter by payment period
          schema:
            type: string
            enum:
              - weekly
              - biweekly
              - fortnightly
              - monthly
        - name: status
          in: query
          description: Filter by status
          schema:
            type: string
            enum:
              - active
              - inactive
        - name: currency
          in: query
          description: Filter by currency (ISO 4217)
          schema:
            type: string
        - in: query
          name: page
          description: Page number
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: Items per page (max 500)
          schema:
            type: integer
            default: 50
            maximum: 500
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Compensation ID
                        companyId:
                          type: string
                          format: uuid
                          description: Company ID
                        name:
                          type: string
                          description: Compensation name
                          example: Comision por ventas
                        compensationType:
                          type: string
                          enum:
                            - fixed
                            - variable
                            - additional
                          description: >-
                            Compensation type: fixed (requires quantity),
                            variable or additional (require quantity OR
                            percentage)
                        quantity:
                          type: number
                          nullable: true
                          description: Fixed amount (mutually exclusive with percentage)
                          example: 1500
                        percentage:
                          type: number
                          nullable: true
                          description: >-
                            Percentage of gross salary (mutually exclusive with
                            quantity)
                          example: 10.5
                        period:
                          type: string
                          enum:
                            - weekly
                            - biweekly
                            - fortnightly
                            - monthly
                          description: Payment period (yearly is NOT valid for payroll)
                        currency:
                          type: string
                          description: Currency code (ISO 4217)
                          example: MXN
                        recurrence:
                          type: integer
                          description: Payment recurrence
                          example: 1
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                          description: Compensation status
                        origin:
                          type: string
                          enum:
                            - payroll
                            - general
                          nullable: true
                          description: Origin of the compensation
                        code:
                          type: string
                          nullable: true
                          description: External code (for Contpaqi integration)
                        comment:
                          type: string
                          nullable: true
                          description: Optional comment
                        createdAt:
                          type: string
                          format: Y-m-dTH:i:sP
                          example: '2020-01-01T10:00:00+01:00'
                        updatedAt:
                          type: string
                          format: Y-m-dTH:i:sP
                          example: '2020-01-01T10:00:00+01:00'
                  meta:
                    type: object
                    properties:
                      currentPage:
                        type: integer
                        example: 1
                      lastPage:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
                      perPage:
                        type: integer
                        example: 1
        '401':
          description: Unauthorized - Invalid or missing API Key
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message indicating authentication failure
                    example: Invalid or missing API Key
                  code:
                    type: string
                    description: Error code for programmatic handling
                    example: UNAUTHORIZED
              example:
                message: Invalid or missing API Key
                code: UNAUTHORIZED
        '429':
          description: Too Many Requests - Rate limit exceeded
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````