Skip to main content

Guide Picker

Returns all supplier staff grouped into three availability buckets for a slot โ€” available, partial, and unavailable. Mirrors the guide-picker dropdown shown in the scheduling UI.

Endpointโ€‹

GET /v1/experience-availability/{id}/guides/picker

Authenticationโ€‹

Requires an API key with the experiences:read scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerExperience availability slot ID

Responseโ€‹

Success (200 OK)โ€‹

{
"data": {
"available": [
{ "id": 5, "name": "Jane Smith", "reason": null },
{ "id": 9, "name": "Carlos Ruiz", "reason": null }
],
"partial": [
{ "id": 8, "name": "Tom Jones", "reason": "Has another shift ending 30 minutes before" }
],
"unavailable": [
{ "id": 3, "name": "Sam Lee", "reason": "On approved leave" }
]
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-04-01T09:00:00+00:00"
}
}

Response Fieldsโ€‹

Each staff entry in all three groups contains:

FieldTypeDescription
idintegerStaff member ID
namestringFull name
reasonstring|nullReason for partial availability or unavailability

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks experiences:read scope
404not_foundAvailability slot not found or belongs to another supplier

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/experience-availability/12/guides/picker" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."