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

NameTypeDescription
startDatestring (date)

Start date for filtering (YYYY-MM-DD format)

Example 2025-01-01.

endDatestring (date)

End date for filtering (YYYY-MM-DD format)

Example 2025-12-31.

startTimestring (time)

Filter whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime.

Example 09:00:00.

endTimestring (time)

Filter whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime.

Example 17:00:00.

shiftBlocksstring

Comma-separated shift block IDs (only for type=shift)

Example 1,2,3.

assignmentShiftIdstring

Assignment ID (type=assignment) or Shift ID (type=shift) to exclude providers already assigned to it

Example ASG-XDMSDH.

employmentStatusstring

Employment status filter

Example staff.

serviceTypesstring

Comma-separated service type IDs

Example 1,2,3.

serviceProviderTypesstring

Comma-separated service provider type IDs

Example 1,2.

locationTypesstring

Comma-separated location types

Example remote,onsite,hybrid.

skillsstring

Comma-separated skill IDs

Example 1,2,3.

specializationsstring

Comma-separated specialization IDs

Example 1,2.

certificationsstring

Comma-separated certification IDs

Example 1,2,3.

clearancesstring

Comma-separated clearance IDs

Example 1,2.

clientstring

Client ID for favorite provider filtering

Example CLT-ABC123.

consumerstring

Consumer ID for favorite provider filtering (only for type=assignment)

Example USER-XYZ789.

typestring

Type filter (assignment or shift)

One of: assignment, shift. Example assignment.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Service provider availability retrieved successfully",
  "data": {
    "availableProviders": {},
    "favoriteProviders": {},
    "partiallyAvailableProviders": {}
  }
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service provider availability retrieved successfully.

dataobject
data.availableProvidersobject
data.favoriteProvidersobject
data.partiallyAvailableProvidersobject
401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'schedule:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.