Employees

List an employee batch

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.
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

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

cursorstring nullable

Pagination cursor: the next_cursor of the previous page.

limitinteger

Number of objects to return, between 1 and 100 (default 25).

statuses[]string[] required

Only batches in these statuses, e.g. draft, quoted, paid, completed or failed (repeat the parameter).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Current durable operation.

next_cursorstring nullable required
has_moreboolean required

Example response

{
  "data": [
    {
      "items": [
        {
          "profile": {
            "first_name": "Ana",
            "last_name": "Acceptance"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.