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

# Get All Payrolls

> Returns all payroll runs for the authenticated organization.



## OpenAPI

````yaml GET /getAllPayroll
openapi: 3.0.0
info:
  title: Toku API
  version: 1.0.0
  description: >-
    The Toku API lets you programmatically manage token grants, wallets,
    employees, payroll, and invoices. Build custom integrations and automate
    your token compensation workflows.
servers:
  - url: https://app.toku.com/api/tokuApi/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Grants
    description: Create, list, terminate, and revert token grants
  - name: Wallets
    description: Manage recipient wallets, verification, and distributions
  - name: Employees
    description: Manage user roles within your organization
  - name: Tokens & Networks
    description: Configure token types and blockchain networks for your organization
  - name: Invoices
    description: Submit and settle invoice payments
  - name: Organization
    description: Configure organization settings
  - name: Distributions
    description: >-
      Approve vestings, add tax details, update FMV, finalize, submit
      settlements, and track status
  - name: Custody
    description: >-
      Connect custody providers (Fireblocks, Anchorage, Safe), manage custody
      wallets, and allocate to grants
  - name: Authentication
    description: Partner API token management
  - name: Payroll
    description: Payroll run creation, management, and state transitions
  - name: EOR
    description: Employer of Record employee onboarding and management
  - name: Payslips
    description: Payslip generation, upload, and retrieval
  - name: Webhooks
    description: Webhook endpoint management and event delivery
  - name: Stablecoin Funding
    description: Token payroll creation and stablecoin settlement
paths:
  /getAllPayroll:
    get:
      tags:
        - Payroll
      summary: List payroll runs
      description: Returns all payroll runs for the authenticated organization.
      operationId: getAllPayroll
      parameters:
        - name: x-role-type
          in: header
          required: true
          description: >-
            Role context for the request. Use CLIENT_ORG_ADMIN for most
            integrations.
          example: CLIENT_ORG_ADMIN
          schema:
            type: string
            enum:
              - CLIENT_ORG_ADMIN
              - PAYROLL_ADMIN
              - FINANCE_ADMIN
              - TOKU_ADMIN
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllPayrollResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    GetAllPayrollResponse:
      type: object
      required:
        - payrolls
      properties:
        payrolls:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Payroll identifier
              name:
                type: string
                description: Payroll display name
              entity:
                type: string
                description: Payroll entity name or identifier
              payPeriodStart:
                type: string
                format: date-time
                description: Payroll period start date
              payPeriodEnd:
                type: string
                format: date-time
                description: Payroll period end date
              payDate:
                type: string
                format: date-time
                description: Scheduled payroll pay date
              currentStep:
                type: string
                description: Current workflow step
              state:
                $ref: '#/components/schemas/TgaPayrollState'
              type:
                type: string
                description: Payroll type
              externalPayrollID:
                type: string
                description: External payroll identifier
                nullable: true
              fiatCurrency:
                type: string
                description: Fiat settlement currency
              stableCoinCurrency:
                type: string
                description: Stablecoin currency code
                nullable: true
              tokenTypeID:
                type: string
                format: uuid
                description: Token type identifier
                nullable: true
              exchangeRate:
                type: number
                description: FX rate used for payroll calculations
                nullable: true
              isStablecoinPayrollComplete:
                type: boolean
                description: Whether stablecoin settlement is complete
              isFiatPayrollComplete:
                type: boolean
                description: Whether fiat settlement is complete
              isSyncedFromHRIS:
                type: boolean
                description: Whether payroll originated from HRIS sync
              selectedEmployeeIds:
                type: array
                items:
                  type: string
                  description: Selected employee identifier
              importedData:
                type: object
                description: Imported employee data payload
                properties: {}
                additionalProperties: true
              processedData:
                type: object
                description: Processed employee payroll data payload
                properties: {}
                additionalProperties: true
              settlementData:
                type: object
                description: Settlement calculation payload
                properties: {}
                additionalProperties: true
              isCsvUploaded:
                type: boolean
                description: Whether payroll data came from CSV upload
              createdAt:
                type: string
                format: date-time
                description: Creation timestamp
              updatedAt:
                type: string
                format: date-time
                description: Last update timestamp
              createdByID:
                type: string
                format: uuid
                description: Creator role-in-org identifier
              lastModifiedByID:
                type: string
                format: uuid
                description: Last modifier role-in-org identifier
              orgID:
                type: string
                format: uuid
                description: Organization identifier
          description: Payroll runs for the authenticated organization
    TgaPayrollState:
      type: string
      description: Payroll lifecycle state.
      enum:
        - DRAFT
        - CALCULATING
        - APPROVED
        - FUNDING
        - COMPLETED
        - FAILED
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Short error message
        details:
          type: string
          description: Additional debugging information
  responses:
    Unauthorized:
      description: Authentication failed — token missing, invalid, or expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Caller does not have the required role
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded (100 req/min per IP)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal API token. Create via createUserApiToken endpoint.

````