API reference › Assignments › Calendar

Retrieve a list of assignments

GET /v1/schedule/calendar/assignments

Scope
schedule:read assignments:read

Fetches a list of assignments based on status search criteria. For a service provider who holds only part of a partial-coverage job, start and end span their own hours (first covered start to last covered end); every other role is unchanged.

Parameters

Query parameters

NameTypeDescription
statusstring

Comma-separated list of assignment-status IDs, e.g. 1,2,3 — a single ID works too. This mirrors the calendar's status checkboxes: the response contains only the statuses you list, and omitting the parameter (or sending it empty) returns an empty list rather than everything, matching an all-unchecked filter. Each ID is matched exactly — a parent status does not pull in its children, so list every status you want. Statuses are tenant-configurable rows, not a fixed vocabulary, so there is no enum here and the example is an example, not a contract — read the valid IDs for this tenant from GET /assignment-statuses. A hard-coded value will go stale the moment a tenant edits its statuses.

Example 1,2,3,4,5,6,7.

startDatestring (date)

Filter assignments by scheduled start date on or after this date (YYYY-MM-DD).

endDatestring (date)

Filter assignments by scheduled end date on or before this date (YYYY-MM-DD).

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

Example request

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

Try it

Responses

200 Assignments retrieved successfully

Assignments retrieved successfully

JSON
{
  "success": true,
  "message": "Assignments Retrieved!",
  "data": [
    {
      "id": "ASG-XY9EML",
      "title": "Example title",
      "start": "2026-01-15",
      "end": "2026-01-15",
      "convertedStart": "2026-01-15 09:00 AM",
      "convertedEnd": "2026-01-15 09:00 AM",
      "status": {
        "id": 1,
        "label": "Example label"
      },
      "type": "assignments"
    }
  ]
}
Response fields (13)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignments Retrieved!.

dataarray of object
data[].idstring

Example ASG-XY9EML.

data[].titlestring or null

Example Example title.

data[].startstring or null

Example 2026-01-15.

data[].endstring or null

Example 2026-01-15.

data[].convertedStartstring or null

Example 2026-01-15 09:00 AM.

data[].convertedEndstring or null

Example 2026-01-15 09:00 AM.

data[].statusobject or null
data[].status.idinteger

Example 1.

data[].status.labelstring or null

Example Example label.

data[].typestring

Example assignments.

400 Bad request

Bad Request - Invalid query parameters

JSON
{
  "success": false,
  "message": "Invalid parameters. Ensure all required filters are correct."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid parameters. Ensure all required filters are correct..

401 Not signed in

Unauthorized - Authentication required

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": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..