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

# List payroll runs

> Returns the company's payroll runs, most recent first. A test-mode key returns only test-mode runs.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json get /v1/payroll/runs
openapi: 3.1.1
info:
  title: Kua API
  description: >-
    The Kua developer API — payroll, wallets, and payments for your own company.


    Authenticate with an API key issued from **Settings → API keys** in the
    dashboard, sent in the `X-Api-Key` header. Every request is scoped to the
    company that owns the key. Base URL: `https://api.kuahr.com` (all endpoints
    are versioned under `/v1`).
  version: v1
servers:
  - url: https://api.kuahr.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Payroll
    description: List and create payroll runs.
  - name: Employees
    description: Add people to your company.
  - name: Events
    description: The company event timeline (also delivered via webhooks).
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Test data
    description: Manage sandbox (test-mode) data.
  - name: Leave
    description: >-
      Time-off types, requests, balances, and allocations (requires the Leave
      add-on).
  - name: Advances
    description: Salary advances (requires the Salary advance add-on).
  - name: Performance
    description: OKRs, appraisals, and promotions (requires the Performance add-on).
paths:
  /v1/payroll/runs:
    get:
      tags:
        - Payroll
      summary: List payroll runs
      description: >-
        Returns the company's payroll runs, most recent first. A test-mode key
        returns only test-mode runs.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PayrollRunSummary'
              example:
                - id: 8ab1c2d3-0000-0000-0000-000000000001
                  year: 2026
                  month: 7
                  status: Disbursed
                  currencyIsoCode: NGN
                  hrApprovedAt: '2026-07-24T09:00:00+00:00'
                  disbursementCompletedAt: '2026-07-25T10:30:00+00:00'
        '401':
          description: Unauthorized
components:
  schemas:
    PayrollRunSummary:
      required:
        - id
        - year
        - month
        - status
        - currencyIsoCode
        - hrApprovedAt
        - disbursementCompletedAt
      type: object
      properties:
        id:
          type: string
          description: The run's unique identifier.
          format: uuid
        year:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Calendar year the run pays for.
          format: int32
        month:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Calendar month (1–12) the run pays for.
          format: int32
        status:
          type: string
          description: Lifecycle status, e.g. `Draft`, `HrApproved`, `Disbursed`.
        currencyIsoCode:
          type: string
          description: ISO-4217 currency code, e.g. `NGN`.
        hrApprovedAt:
          type:
            - 'null'
            - string
          description: When HR approved the run (null until approved).
          format: date-time
        disbursementCompletedAt:
          type:
            - 'null'
            - string
          description: When disbursement finished settling (null until disbursed).
          format: date-time
      description: A payroll run in the company's history.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Your API key, e.g. `kua_live_…` (or `kua_test_…` in test mode).
      name: X-Api-Key
      in: header

````