API reference › Schedule › Overviews

Get admin schedule overview

GET /v1/schedule/overview

Scope
schedule:read
Roles
admin, scheduler

Retrieve schedule overview data for admin panel (assignments or shifts). Without Finance Read assignmentCostData.totalCost is null and assignmentCostData.labelBreakdown is empty.

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.

typestring

Type filter (assignment or shift)

One of: assignment, shift. Example assignment.

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.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/schedule/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": {}
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Schedule overview retrieved successfully.

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