API reference › Schedule › Assign and availability

Get organization or service provider availability

GET /v1/schedule/calendar/org-provider-availability

Scope
schedule:read providers:read

Retrieve availability for organization office hours or authenticated service provider with detailed time slots

Parameters

Query parameters

NameTypeDescription
startDatestring (date)

Start date (defaults to today)

Example 2025-11-28.

endDatestring (date)

End date (defaults to today)

Example 2025-11-28.

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.

availabilitystring

Filter by availability status: available, unavailable, or both (comma-separated)

Example available,unavailable.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/schedule/calendar/org-provider-availability" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Availability retrieved successfully

Availability retrieved successfully

JSON
{
  "success": true,
  "message": "Availability retrieved successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Availability retrieved successfully.

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.