Work Schedules

List a schedule’s assignments

List the employees with an open assignment (effective_to = null) to this work schedule, as a flat list under { "data": [ … ] }.

get/companies/{company}/work-schedules/{schedule}/assignments

Request

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

schedulestring uuid required

Public identifier (UUID v7) of the work schedule.

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

Example response

{
  "data": [
    {
      "id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f02",
      "object": "work_schedule_assignment",
      "work_schedule_id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f01",
      "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
      "effective_from": "2024-09-02",
      "created_at": "2024-09-02T08:00:00Z"
    }
  ]
}

Changes

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