> ## Documentation Index > Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt > Use this file to discover all available pages before exploring further. # List > Fetch all payrolls ## OpenAPI ````yaml /openapi/workforce-management.yaml get /v1/payrolls openapi: 3.0.0 info: description: APIs for interacting with Cadana Payroll Platform version: 1.0.0 title: Business Workforce Management termsOfService: https://cadanapay.com/terms-and-conditions contact: email: api@cadanapay.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.cadanapay.com description: Prod Server - url: https://dev-api.cadanapay.com description: Dev Server security: - Authorization: [] tags: - name: Custom Auth description: APIs for interacting with Custom Authentication - name: Persons description: APIs for interacting with the HR module - name: Milestones description: APIs for milestone-based contractor pay - name: Instant Pay description: APIs for interacting with Instant Pay functionality - name: Users description: APIs for interacting with employee/contractor Cadana accounts - name: Files description: APIs for interacting with file uploads - name: Payrolls description: APIs for interacting with Payroll - name: Platform description: Platform APIs for interacting with businesses - name: Businesses description: APIs for interacting with Business - name: Contracts description: APIs for interacting with contracts - name: Sandbox description: APIs for relevant sandbox simulations - name: Invoices description: APIs for interacting with invoices - name: Reimbursements description: APIs for interacting with reimbursements - name: Entities description: >- APIs for managing legal sub-entities (subsidiaries, branches) under a parent business paths: /v1/payrolls: get: tags: - Payrolls summary: List description: Fetch all payrolls operationId: retrievePayrolls parameters: - $ref: '#/components/parameters/XMultiTenantKey' responses: '200': $ref: '#/components/responses/GetPayrollsResponse' '400': $ref: '#/components/responses/BadRequestError' security: - Authorization: [] components: parameters: XMultiTenantKey: name: X-MultiTenantKey in: header required: false schema: type: string description: >- Required when using a Platform API token. The tenant key identifying which business to operate on. responses: GetPayrollsResponse: description: get payrolls response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/payrollSummary' BadRequestError: description: Bad input provided by client content: application/json: schema: $ref: '#/components/schemas/BadRequestError' schemas: payrollSummary: type: object properties: payrollId: type: string description: created payroll id format: uuid workerType: type: string description: worker type example: EMPLOYEE enum: - EMPLOYEE - CONTRACTOR status: allOf: - $ref: '#/components/schemas/payrollStatus' description: >- Current payroll status. Values are title-cased (e.g. `Pending Submission`, `Scheduled`, `Completed`). numPeople: type: integer description: number of people in payroll run example: 50 type: type: string description: payroll type example: ONE-OFF enum: - ONE-OFF - REGULAR payrollDate: type: string description: payroll date format: date debit: allOf: - $ref: '#/components/schemas/amount' description: >- Total amount deducted from the business balance for this payroll. For direct employment this is net pay plus fees; for EOR workers (`compInfo.employmentModel: "eor"`) it is gross pay plus employer contributions, so statutory amounts are collected. gross: allOf: - $ref: '#/components/schemas/amount' description: Total gross pay across all entries, before deductions. net: allOf: - $ref: '#/components/schemas/amount' description: Total net (take-home) pay across all entries. tax: allOf: - $ref: '#/components/schemas/amount' description: >- Total income tax withheld across all entries. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. pension: allOf: - $ref: '#/components/schemas/amount' description: >- Combined employee and employer retirement contributions across all entries; the employee and employer portions are also included in `statutoryDeductions` and `employerContributions` respectively. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. statutoryDeductions: allOf: - $ref: '#/components/schemas/amount' description: >- Total of all employee-side statutory deductions, including income tax and social security, across all entries. Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. employerContributions: allOf: - $ref: '#/components/schemas/amount' description: >- Total employer contributions across all entries (e.g., employer-side social security). Returned for `EMPLOYEE` payrolls only; omitted for contractor payrolls. payPeriod: allOf: - $ref: '#/components/schemas/payPeriod' description: The pay period this payroll covers. BadRequestError: description: Bad input provided by client allOf: - $ref: '#/components/schemas/Error' - type: object properties: params: description: A map for meta data around the error that occurred type: object example: code: invalid_request_body message: The request body provided is not valid params: field: Value is invalid. payrollStatus: type: string description: > Current payroll status. See [Payroll Lifecycle](/workforce/payroll-lifecycle) for the meaning of each value and the allowed transitions. example: Completed enum: - Created - Pending Submission - Pending Approval - Awaiting Funds - Scheduled - Processing - Completed - Rejected - Deleted amount: type: object required: - amount - currency properties: amount: type: integer description: value in lowest denomination example: 10000 currency: type: string description: currency example: USD payPeriod: type: object properties: fromDate: type: string description: start date format: date toDate: type: string description: end date format: date Error: type: object properties: code: description: A machine parsable error code type: string enum: - invalid_request_body - resource_not_found - forbidden - internal_error message: description: A human readable message describing the error type: string securitySchemes: Authorization: type: http scheme: bearer bearerFormat: API_SECRET_KEY ````