API reference › Schedule › Overviews
Get provider portal schedule overview
GET /v1/schedule/provider-portal/overview
- Scope
schedule:read- Roles
- service-provider
Retrieve schedule overview data for provider portal (assignments and shifts combined)
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 |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/schedule/provider-portal/overview" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Schedule overview retrieved successfully
Schedule overview retrieved successfully
{
"success": true,
"message": "Schedule overview retrieved successfully",
"data": {
"startDate": "2026-01-15",
"endDate": "2026-01-15",
"assignments": {
"totalAssignments": 74,
"available": 55,
"unavailable": 19
},
"serviceLocations": {
"totalServiceLocations": 100,
"remote": 55,
"onsite": 20,
"hybrid": 25
},
"serviceLocationStats": {
"total": 0,
"locations": {}
},
"confirmedAssignmentsByServiceType": [
{
"category": "ASL",
"filled": 42,
"unfilled": 18
}
],
"pendingActions": {
"total": 0,
"breakdown": {}
},
"forecastedEarning": {
"total": 0,
"growth": "string"
}
}
}Response fields (27)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (24 nested) |
Nested fields
data 24 fields
| Field | Type | Description |
|---|---|---|
data.startDate | string or null | Example |
data.endDate | string or null | Example |
data.assignments | object | |
data.assignments.totalAssignments | integer | Example |
data.assignments.available | integer | Example |
data.assignments.unavailable | integer | Example |
data.serviceLocations | object | |
data.serviceLocations.totalServiceLocations | integer | Example |
data.serviceLocations.remote | integer | Example |
data.serviceLocations.onsite | integer | Example |
data.serviceLocations.hybrid | integer | Example |
data.serviceLocationStats | object | |
data.serviceLocationStats.total | number | Example |
data.serviceLocationStats.locations | object | |
data.confirmedAssignmentsByServiceType | array of object | |
data.confirmedAssignmentsByServiceType[].category | string | Example |
data.confirmedAssignmentsByServiceType[].filled | integer | Example |
data.confirmedAssignmentsByServiceType[].unfilled | integer | Example |
data.pendingActions | object | |
data.pendingActions.total | number | Example |
data.pendingActions.breakdown | object | |
data.forecastedEarning | object | |
data.forecastedEarning.total | number | Example |
data.forecastedEarning.growth | string |
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 |
422 Validation failed
Validation error
{
"success": false,
"message": "Validation failed"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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 |