Employees

Retrieve an employee batch

Retrieve an employee batch and its financial outcome.

  • GET the same UUID after a 202, failure or replay until a verified terminal state.
  • Unknown totals never mean free; financial history exposes no private codes or Stripe identifiers.
get/companies/{company}/employee-batches/{id}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/employee-batches/{id}
  • 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).

idstring uuid required

Public identifier (UUID v7) of the employee batch.

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.

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.