---
title: "List a schedule’s assignments"
method: GET
path: "/companies/{company}/work-schedules/{schedule}/assignments"
tags: ["Work Schedules"]
---

# List a schedule’s assignments

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

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

## Path parameters

- `company` string, uuid, required
- `schedule` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` ScheduleAssignment[], required
    - `id` string, uuid, required: Opaque identifier of the assignment, a UUID v7.
    - `object` 'work_schedule_assignment', required: Always `work_schedule_assignment`.
    - `work_schedule_id` string, uuid, required: UUID v7 of the assigned work schedule.
    - `employee_id` string, uuid, required: UUID v7 of the assigned employee.
    - `effective_from` string, date, required: Date the assignment starts being effective, in `Y-m-d`.
    - `effective_to` string, date, nullable, required: Date the assignment stops being effective, in `Y-m-d`; `null` while open.
    - `created_at` string, date-time, nullable, required: Creation timestamp (ISO 8601).

## 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.
- `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)