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

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.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Schedule overview retrieved successfully.

dataobject (24 nested)

Nested fields

data 24 fields
FieldTypeDescription
data.startDatestring or null

Example 2026-01-15.

data.endDatestring or null

Example 2026-01-15.

data.assignmentsobject
data.assignments.totalAssignmentsinteger

Example 74.

data.assignments.availableinteger

Example 55.

data.assignments.unavailableinteger

Example 19.

data.serviceLocationsobject
data.serviceLocations.totalServiceLocationsinteger

Example 100.

data.serviceLocations.remoteinteger

Example 55.

data.serviceLocations.onsiteinteger

Example 20.

data.serviceLocations.hybridinteger

Example 25.

data.serviceLocationStatsobject
data.serviceLocationStats.totalnumber

Example 0.

data.serviceLocationStats.locationsobject
data.confirmedAssignmentsByServiceTypearray of object
data.confirmedAssignmentsByServiceType[].categorystring

Example ASL.

data.confirmedAssignmentsByServiceType[].filledinteger

Example 42.

data.confirmedAssignmentsByServiceType[].unfilledinteger

Example 18.

data.pendingActionsobject
data.pendingActions.totalnumber

Example 0.

data.pendingActions.breakdownobject
data.forecastedEarningobject
data.forecastedEarning.totalnumber

Example 0.

data.forecastedEarning.growthstring
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 .

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Validation failed"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation failed.

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!.