---
title: "List staff members"
method: GET
path: "/v1/staff/"
tags: ["Staff"]
---

# List staff members

`GET /v1/staff/`

List staff members

**Required scope: `business/staff:read`**

## Query parameters

- `created_at__gte` string, date-time, nullable — The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `created_at__lte` string, date-time, nullable — The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__gte` string, date-time, nullable — The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__lte` string, date-time, nullable — The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `cursor` string, nullable — A pagination cursor from where results should start being fetched.
- `limit` integer — The maximum number of results to return.
- `status` 'active' | 'inactive'

## Response `200`

Successful Response

- PaginatedResponseStaff
  - `data` Staff[], required — A list of paginated entities.
    - `id` string, required — The unique identifier of the staff member.
    - `staff_number` string, nullable — The staff number set by an external system, such as a point-of-sale integration, used to reconcile this staff member to that system. `null` when no external staff number has been recorded.
    - `role` 'administrator' | 'custom' | 'manager' | 'staff_member' | 'supervisor', required
    - `status` 'active' | 'inactive', required
    - `first_name` string, nullable, required — The first name of the staff member.
    - `last_name` string, nullable, required — The last name of the staff member.
    - `created_at` string, date-time, required — The date and time the staff member was added to the business in ISO 8601 format.
    - `updated_at` string, date-time, required — The date and time the staff member was last updated in ISO 8601 format.
    - `deleted_at` string, date-time, nullable — The date and time the staff member was removed from the business in ISO 8601 format, or `null` if they are still active.
  - `next_cursor` string, nullable, required — A pagination cursor that can be used to retrieve the next set of results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/yoco/apis/yoco-api.md) · [All operations](https://skmtc.net/yoco/apis/yoco-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yoco/yoco-api/revisions/1ee03e82bc45/schema)