Naar navigatie springen
ReceptionStaff

Get All Staff

Get all staff for the current workspace

Headers

xi-api-keystringOptioneel
xi-workspace-idstring or nullOptioneel
The customer workspace a reseller's API key acts on.

Response

Geslaagde response
namestring

Internal/admin name of the staff member, shown in the dashboard and owner notifications.

_idstring
groupslist of objectsOptioneel

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or nullOptioneel>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstringOptioneel
Description or bio of the staff member.
is_activebooleanOptioneelStandaard true
Whether the staff member can be booked. Inactive staff keep their booking history.
emailstringOptioneelStandaard
Email address of the staff member.
phonestringOptioneel

Phone number of the staff member. Without a country code, +1 (US) is assumed.

sms_notifications_opted_inbooleanOptioneelStandaard false

Whether this staff member currently receives SMS booking notifications. Defaults to opted out — a staff member must be explicitly opted in; flipped to False automatically when they reply STOP to the workspace number.

photo_urlstring or nullOptioneelformaat: "uri"1-2083 characters
location_idstring or nullOptioneel

Location this staff member is assigned to; empty means available at all locations.

working_hoursobject or nullOptioneel

Custom working hours for this staff member. Null means follow the assigned location’s operating_hours (requires location_id).

display_on_booking_pagebooleanOptioneelStandaard true
Whether customers can see and pick this staff member by name on the booking page. False keeps them bookable, just not shown by name.
customer_facing_namestringOptioneel

Optional public-facing label. When empty, name is shown to customers too. name stays the internal/admin label used in the dashboard and business-owner notifications.

created_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

Fouten

422
Unprocessable Entity Error