Employees

List employee invitations

List the employee invitations of your company. Only invitations with role employee are returned; user/admin invitations from the user-management surface are excluded. Each item exposes its opaque id (UUID v7), email, status (pending/accepted/canceled/expired) and expiry.

get/companies/{company}/employee-invitations

Request

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

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

has_moreboolean required

Whether more pages are available after this one.

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

Example response

{
  "data": [
    {
      "id": "01933a70-48ed-77f9-9f06-da4b5c6d7e01",
      "object": "employee_invitation",
      "email": "nuevo.empleado@empresa.com",
      "role": "employee",
      "status": "pending",
      "expires_at": "2026-06-15T09:00:00Z",
      "created_at": "2026-06-01T09:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

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