> ## Documentation Index > Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Compensations > Returns a list of Compensation objects. ## OpenAPI ````yaml get /api/hris/v1/compensations openapi: 3.1.0 info: title: Bindbee APIs version: 0.1.0 servers: - url: https://api.bindbee.dev - url: https://api-eu.bindbee.dev security: [] paths: /api/hris/v1/compensations: get: tags: - Compensation summary: Get Compensations description: Returns a list of Compensation objects. operationId: get_compensations_api_hris_v1_compensations_get parameters: - name: ids in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the compensations to fetch examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Ids description: The ID of the compensations to fetch - name: employee_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the employees to fetch compensation for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Employee Id description: The ID of the employees to fetch compensation for - name: remote_id in: query required: false schema: type: string description: The third-party API ID of the matching object. examples: - '3235005483341316245' title: Remote Id description: The third-party API ID of the matching object. - name: pay_group_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the pay groups to fetch compensation for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Pay Group Id description: The ID of the pay groups to fetch compensation for - name: include_raw_data in: query required: false schema: type: boolean description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. examples: - false default: false title: Include Raw Data description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. - name: include_custom_fields in: query required: false schema: type: boolean description: Whether to include custom fields in the response. examples: - false default: false title: Include Custom Fields description: Whether to include custom fields in the response. - name: page_size in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Number of results to return per page. Maximum size is 200. default: 50 title: Page Size description: Number of results to return per page. Maximum size is 200. - name: cursor in: query required: false schema: type: string description: The pagination cursor value. title: Cursor description: The pagination cursor value. - name: modified_after in: query required: false schema: type: string description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601) examples: - '2024-02-21T21:22:12.993Z' title: Modified After description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601) - name: start_date_from in: query required: false schema: type: string description: >- If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601) examples: - '2024-02-21T21:22:12.993Z' title: Start Date From description: >- If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601) - name: start_date_to in: query required: false schema: type: string description: >- If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601) examples: - '2024-02-21T21:22:12.993Z' title: Start Date To description: >- If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601) - name: expand in: query required: false schema: type: string description: >- Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. examples: - manager[first_name,last_name] title: Expand description: >- Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. - name: x-connector-token in: header required: true schema: type: string title: X-Connector-Token responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_HrisCompensation_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: PaginatedResponse_HrisCompensation_: properties: cursor: anyOf: - type: string - type: 'null' title: Cursor description: Cursor value to fetch next set of items examples: - MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1 page_size: type: integer title: Page Size description: Indicates the count of items in the response examples: - 50 items: items: $ref: '#/components/schemas/HrisCompensation' type: array title: Items description: List of items in the current response examples: - {} type: object required: - cursor - page_size - items title: PaginatedResponse[HrisCompensation] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HrisCompensation: properties: id: type: string format: uuid title: Id examples: - 018b18ef-c487-703c-afd9-0ca478ccd9d6 remote_id: anyOf: - type: string - type: 'null' title: Remote Id description: The third-party API ID of the matching object. examples: - '123321' modified_at: type: string title: Modified At description: This is the datetime that this object was last updated by Bindbee examples: - '2021-10-16T00:00:00Z' raw_data: anyOf: - additionalProperties: true type: object - type: 'null' title: Raw Data description: This is the Raw data examples: - key_1: Platform dependent data 1 key_2: Platform dependent data 2 custom_fields: anyOf: - additionalProperties: true type: object - type: 'null' title: Custom Fields description: The custom fields related to the model examples: - category_group: REG disability_type: ASBERG hire_date: '1991-03-16T00:00:00' hire_source: REFER nationality: USA original_hire_date: '1991-03-16T00:00:00' employee: anyOf: - {} - type: 'null' title: Employee description: The employee holding this position. examples: - 018abccc-3208-7b2d-8b86-927945f89a42 pay_group: anyOf: - {} - type: 'null' title: Pay Group description: The employee's pay group. examples: - 018b802f-4856-7ea8-a83f-ac374853ab90 pay_rate: anyOf: - type: integer - type: number - type: 'null' title: Pay Rate description: The position's pay rate in dollars. examples: - 77000 pay_period: anyOf: - type: string - type: 'null' enum: - HOUR - DAY - WEEK - EVERY_TWO_WEEKS - EVERY_FOUR_WEEKS - TWICE_PER_MONTH - SEMIMONTHLY - MONTH - QUARTER - EVERY_SIX_MONTHS - YEAR - '-' title: Pay Period description: >- The time period this pay rate encompasses. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - YEAR pay_frequency: anyOf: - type: string - type: 'null' enum: - HOURLY - WEEKLY - BIWEEKLY - QUARTERLY - SEMIANNUALLY - ANNUALLY - THIRTEEN-MONTHLY - PRO_RATA - SEMIMONTHLY - MONTHLY - FOURWEEKLY - '-' title: Pay Frequency description: >- The position's pay frequency. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - MONTHLY pay_currency: anyOf: - type: string - type: 'null' title: Pay Currency description: The position's currency code. examples: - USD flsa_status: anyOf: - type: string - type: 'null' enum: - EXEMPT - SALARIED_NONEXEMPT - NONEXEMPT - OWNER - '-' title: Flsa Status description: >- The position's FLSA status. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - EXEMPT start_date: anyOf: - type: string - type: 'null' title: Start Date description: The position's start date. examples: - '2022-12-15T00:00:00Z' type: object required: - id - remote_id - modified_at - custom_fields - employee - pay_group - pay_rate - pay_period - pay_frequency - pay_currency - flsa_status - start_date title: HrisCompensation ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: HTTPBearer: type: http scheme: bearer ````