---
title: "List all employees"
method: GET
path: "/companies/{company}/employees"
tags: ["Employees"]
---

# List all employees

`GET /companies/{company}/employees`

## Request

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

List the employees of your company with cursor-based pagination. Supports filtering by `status` (`active`/`inactive`), `employment_type` (`full_time`/`part_time`) and `ccaa`, plus free-text `search` over name and email.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `ending_before` string, uuid
- `status` 'active' | 'inactive'
- `status[in]` string: Comma-separated list of values (CSV).
- `employment_type` 'full_time' | 'part_time'
- `employment_type[in]` string: Comma-separated list of values (CSV).
- `ccaa` string
- `ccaa[in]` string: Comma-separated list of values (CSV).
- `search` string

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object: Cursor-paginated list envelope shared by every v1 listing endpoint. `data` holds the page items; `has_more` signals whether another page exists; `next_cursor` is the cursor to pass back for the following page. Treat it as strictly opaque: send it through verbatim, never parse it and never assume a format — it is not the same across listings, and each listing documents its own cursor parameter. Concrete listings narrow `data` to their resource type via `allOf`.
  - `data` object[], required: Items on the current page.
    - `id` string, uuid, required: Opaque identifier of the employee, a UUID v7 (e.g. `01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a9b`).
    - `object` 'employee', required: Always `employee`.
    - `first_name` string, required: Given name of the employee.
    - `last_name` string, required: Family name of the employee.
    - `email` string, email, required: Contact email of the employee.
    - `tax_id` string, nullable, required: Spanish fiscal identifier (NIF/NIE) of the employee, or `null` when unknown. Not a foreign key.
    - `job_title` string, nullable, required: Role or position of the employee, or `null` when unset.
    - `employment_type` 'full_time' | 'part_time', required: Working-hours arrangement: `full_time` or `part_time`.
    - `contract_hours` number, float, required: Weekly contracted hours (e.g. `40` for a full-time schedule).
    - `hire_date` string, date, required: Calendar date the employee was hired, in `Y-m-d`.
    - `termination_date` string, date, nullable, required: Calendar date the employee was deactivated, in `Y-m-d`; `null` while active.
    - `ccaa` 'AN' | 'AR' | 'AS' | 'IB' | 'CN' | 'CB' | 'CL' | 'CM' | 'CT' | 'VC' | 'EX' | 'GA' | 'MD' | 'MC' | 'NC' | 'PV' | 'RI' | 'CE' | 'ML', required: Spanish autonomous community (comunidad autónoma) the employee is assigned to, as its two-letter code.
    - `status` 'active' | 'inactive', required: Lifecycle status: `active` (in the workforce) or `inactive` (deactivated).
    - `external_id` string, nullable: External integration key (ERP/CRM/HR system) mapping this employee to a record in a third-party system. Free-format, unique per company, distinct from the fiscal `tax_id`.
    - `metadata` Metadata, nullable, required: A free map of up to 50 key→value pairs for storing arbitrary structured data (values are strings up to 500 characters). Unlike `custom_fields` — an ordered list of typed `{field, value}` pairs with display semantics, present on the six document resources — `metadata` is an unordered map for opaque integration data; a document may carry both. The master resources (Client, Supplier) have no `custom_fields`, so their `metadata` doubles as the custom-fields store. **Reserved keys (read-only).** When the system auto-issues an invoice from a payment correlation (Stripe/GoCardless/MONEI), it writes `stripe_subscription_id`, `stripe_invoice_id`, `billing_reason`, `period_start` and `period_end` into that invoice metadata automatically. Do not set or overwrite them by hand — the platform owns them and a manual value may be replaced when the correlation runs.
    - `user_id` string, uuid, nullable, required: UUID v7 of the portal user linked to this employee, or `null` when no linkage exists yet.
    - `created_at` string, date-time, nullable, required: Creation timestamp (ISO 8601).
    - `updated_at` string, date-time, nullable, required: Last-update timestamp (ISO 8601).
  - `has_more` boolean, required: Whether more pages are available after this one.
  - `next_cursor` string, nullable, required: Opaque cursor for the next page, or `null` when `has_more` is `false`. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

## Other responses

- `400`: `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)