Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Staff

List staff members

List staff members

Required scope: business/staff:read

get/v1/staff/

Query parameters

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

Example:2024-11-19T15:27:02+00:00

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

Example:2024-11-19T15:27:02+00:00

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

Example:2024-11-19T15:27:02+00:00

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

Example:2024-11-19T15:27:02+00:00

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.

cursorstring nullable

A pagination cursor from where results should start being fetched.

A pagination cursor from where results should start being fetched.

limitinteger

The maximum number of results to return.

The maximum number of results to return.

status'active' | 'inactive'

Filter staff by whether they are currently active in the business. When omitted, both active and inactive (removed) staff are returned so that historical records referencing a removed staff member can still be resolved. Pass active or inactive to narrow the list.

Response

Successful Response

next_cursorstring nullable required

A pagination cursor that can be used to retrieve the next set of results.

Example response

{
  "data": [],
  "next_cursor": "1323935095007282836"
}