API reference › Schedule › Assign and availability
Check service provider availability
GET /v1/schedule/check-provider-availability
- Scope
schedule:read- Roles
- admin, scheduler
Retrieve available and favorite service providers based on filters
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
startDate | string (date) | Start date for filtering (YYYY-MM-DD format) Example |
endDate | string (date) | End date for filtering (YYYY-MM-DD format) Example |
startTime | string (time) | Filter whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime. Example |
endTime | string (time) | Filter whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime. Example |
shiftBlocks | string | Comma-separated shift block IDs (only for type=shift) Example |
assignmentShiftId | string | Assignment ID (type=assignment) or Shift ID (type=shift) to exclude providers already assigned to it Example |
employmentStatus | string | Employment status filter Example |
serviceTypes | string | Comma-separated service type IDs Example |
serviceProviderTypes | string | Comma-separated service provider type IDs Example |
locationTypes | string | Comma-separated location types Example |
skills | string | Comma-separated skill IDs Example |
specializations | string | Comma-separated specialization IDs Example |
certifications | string | Comma-separated certification IDs Example |
clearances | string | Comma-separated clearance IDs Example |
client | string | Client ID for favorite provider filtering Example |
consumer | string | Consumer ID for favorite provider filtering (only for type=assignment) Example |
type | string | Type filter (assignment or shift) One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/schedule/check-provider-availability" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Service provider availability retrieved successfully
Service provider availability retrieved successfully
{
"success": true,
"message": "Service provider availability retrieved successfully",
"data": {
"availableProviders": {},
"favoriteProviders": {},
"partiallyAvailableProviders": {}
}
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.availableProviders | object | |
data.favoriteProviders | object | |
data.partiallyAvailableProviders | object |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'schedule:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |