Retrieve a list of assignments
GET /v1/assignments
- Scope
assignments:readorshifts:read- Roles
- admin, scheduler
Fetches a paginated list of assignments based on search criteria, filters, and sorting options. With isFromPortal=true the list also carries shifts (the Summary tab of a client, consumer or provider); a Scheduler or custom role needs Read on Assignments or Shifts (an API key the matching scope): assignments are left out without Assignments Read, shifts without Shifts Read, and without either the answer is an empty page.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter assignmenr by name, email, or assignment Id. Example |
priority | integer | Filter assignment by priority ID. Example |
status | integer | Filter by assignment-status ID. Statuses are tenant-configurable rows, not a fixed vocabulary, so there is no enum here — 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 |
serviceTypes | integer | Filter assignment by service Types ID. Example |
broadcast | string | Filter by broadcast state. Matched exactly against assignments.broadcast. One of: |
serviceProvider | string | Filter assignment by service provider ID. Example |
consumer | string | Filter assignment by consumer ID. Example |
client | string | Filter assignment by client ID. Example |
isPublished | boolean | Filter assignments by their Published status. Example |
without_active_invoice | boolean | when true, only assignments with no active (non-Canceled/Void) invoice link. Example |
without_active_payable | boolean | when true, only assignments with no active (non-Canceled/Void) payable link. Example |
sortBy | string | Sort clients by a specific field (e.g., 'name', 'created_at'). Example |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
perPage | integer | Number of clients to retrieve per page. Example |
columns | string | Search query within visible column content. Example |
customTab | string | Preset filter tab, applied in addition to any other filters. One of: |
startDate | string (date) | Filter assignments by scheduled start date on or after this date (YYYY-MM-DD). |
endDate | string (date) | Filter assignments by scheduled end date on or before this date (YYYY-MM-DD). |
startTime | string (time) | Filter assignments whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime; an overnight range (startTime later than endTime) is handled as spanning midnight. |
endTime | string (time) | Filter assignments whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime. |
page | integer | Page number (default: 1). Example |
locationType | string | Filter by the Location column: the work item location type. One of: |
serviceProviderTypes | integer | Filter by a provider type ID the work item asks for in its service-type breakdown (matches before anyone of that type is assigned). Example |
requestSource | string | Filter by the Request Source column (origin of the request). One of: |
updated_since | string | Only work items that changed at or after this moment: the assignment itself, any of its slots, any of its provider rows (assigned, removed or a status change) or any of its check-ins. Assignments deleted in the window are returned too, with Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/assignments" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Assignments retrieved successfully
Assignments retrieved successfully
{
"success": true,
"data": [
{
"startDate": "2026-01-15",
"endDate": "2026-01-15",
"startTime": "09:00:00",
"endTime": "09:00:00",
"convertedStartDate": "2026-01-15",
"convertedEndDate": "2026-01-15",
"convertedStartTime": "09:00:00",
"convertedEndTime": "09:00:00",
"userTimezone": "America/New_York",
"timezone": "America/New_York",
"assignmentDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
"userDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
"requestedOn": "2026-01-15",
"submissionDate": "2026-01-15",
"timeSlots": {
"id": 1,
"startTime": "09:00:00",
"endTime": "09:00:00"
},
"deletedAt": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50,
"asOf": "2026-10-23T06:00:00Z"
}
}Response fields (27)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (19 nested) | |
meta | object (5 nested) |
Nested fields
data 19 fields
| Field | Type | Description |
|---|---|---|
data[].startDate | string or null | Example |
data[].endDate | string or null | Example |
data[].startTime | string or null | Example |
data[].endTime | string or null | Example |
data[].convertedStartDate | string | Example |
data[].convertedEndDate | string | Example |
data[].convertedStartTime | string | Example |
data[].convertedEndTime | string | Example |
data[].userTimezone | string or null | Example |
data[].timezone | string or null | Example |
data[].assignmentDateTooltip | string | Example |
data[].userDateTooltip | string | Example |
data[].requestedOn | string | Example |
data[].submissionDate | string | Example |
data[].timeSlots | object or null | |
data[].timeSlots.id | integer | Example |
data[].timeSlots.startTime | string | Example |
data[].timeSlots.endTime | string | Example |
data[].deletedAt | string (date-time) or null | Only with updated_since: when the assignment was deleted (UTC, ending in Z), or empty while it exists. |
meta 5 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
meta.asOf | string (date-time) | Only with updated_since: the moment the list was read; use it as the next updated_since. Take it from the first page of a pull; every page reports its own. Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Invalid parameters. Ensure all required filters are correct."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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 'assignments: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
updated_since is not an ISO 8601 date-time with a time zone, or a date.
{
"status": "error",
"message": "An unexpected error occurred — please try again.",
"errors": {
"updated_since": [
"The updated_since must be an ISO 8601 date-time with a time zone (for example 2026-10-22T06:00:00Z) or a date (YYYY-MM-DD)."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object |
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": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |