---
title: "List an employee batch"
method: GET
path: "/companies/{company}/employee-batches"
tags: ["Employees"]
---

# List an employee batch

`GET /companies/{company}/employee-batches`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/employee-batches`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

List the employee batches of the company.
- A batch holds 1 to 100 explicit create profiles or inactive employee UUIDs and sends no invitations.
- Provisioning happens only after one verified financial outcome.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `cursor` string, nullable
- `limit` integer
- `statuses[]` string[], required

## Headers

- `Factuarea-Version` string, date

## Response `200`

Current durable operation.

- object
  - `data` EmployeeBatch[], required
    - `id` string, uuid, required
    - `kind` 'create' | 'reactivate', required
    - `status` 'draft' | 'quoted' | 'processing' | 'requires_action' | 'payment_pending' | 'paid' | 'completed' | 'failed' | 'cancelled' | 'compensating' | 'compensated' | 'needs_review', required
    - `revision` integer, required
    - `quote_version` integer, required
    - `accepted_version` integer, nullable, required
    - `expires_at` string, date-time, nullable, required
    - `quote_expired` boolean, required
    - `requested` integer, required
    - `financial_attempt_started` boolean, required
    - `failure_code` string, nullable, required
    - `quote` EmployeeBatchQuote, required
      - `base_cents` integer, required
      - `discount_cents` integer, required
      - `tax_cents` integer, required
      - `total_cents` integer, required
      - `recurring_base_cents` integer, required
      - `recurring_discount_cents` integer, required
      - `recurring_tax_cents` integer, required
      - `recurring_total_cents` integer, required
      - `proration_date` integer, required
      - `requested` integer, required
      - `active_before` integer, required
      - `covered_count` integer, required
      - `transferred_paid_slots` integer, required
      - `chargeable_count` integer, required
      - `final_active_count` integer, required
      - `fingerprint` string, required
      - `currency` 'EUR', required
      - `seats_billable` boolean, required
      - `requires_payment_method` boolean, required
      - `requires_financial_attempt` boolean, required
      - `expires_at` string, date-time, required
    - `items` object[], required
      - `row_id` string, required
      - `employee_id` string, uuid, nullable
      - `profile` EmployeeBatchProfile
        - `first_name` string, required
        - `last_name` string, required
        - `email` string, email, required
        - `employment_type` 'full_time' | 'part_time', required
        - `contract_hours` number, required
        - `ccaa` 'AN' | 'AR' | 'AS' | 'IB' | 'CN' | 'CB' | 'CL' | 'CM' | 'CT' | 'VC' | 'EX' | 'GA' | 'MD' | 'MC' | 'NC' | 'PV' | 'RI' | 'CE' | 'ML', required
        - `hire_date` string, date, required
        - `tax_id` string, nullable
        - `job_title` string, nullable
        - `external_id` string, nullable
        - `metadata` object
      - `paid_until` string, date-time, nullable
      - `coverage` 'covered' | 'uncovered'
    - `result` object[], required
      - `row_id` string, required
      - `employee_id` string, uuid, required
    - `allowed_actions` string[], required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `action_url` string, uri, nullable, required
    - `payment_setup_url` string, uri, nullable, required
  - `next_cursor` string, nullable, required
  - `has_more` boolean, required

## Other responses

- `400`: The request is syntactically malformed — e.g. an unknown query parameter, an integer parameter with non-numeric value, or a value outside the documented range. `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)