API reference › Assignments › Consumer portal
Retrieve paginated consumer assignments with optional filters
GET /v1/portal/consumer/assignment
- Scope
assignments:read- Roles
- consumer
Fetch a paginated list of consumer assignments. Supports searching, filtering, and sorting.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search keyword |
columns | string | Comma-separated list of searchable columns |
sortBy | string | Column to sort by Example |
sortOrder | string | Sort order One of: |
perPage | integer | Items per page Example |
locationType | string | Filter by location type One of: |
serviceTypes | array of integer | Filter by service type IDs |
client | string | Filter by client |
status | string | Filter by assignment status One of: |
startDate | string (date) | Example |
endDate | string (date) | Example |
requestSource | string | Filter by the Request Source column (origin of the request). One of: |
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. Example |
endTime | string (time) | Filter assignments whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime. Example |
priority | integer | Filter by priority id. Example |
customTab | string | Preset filter tab, applied in addition to any other filters. One of: |
page | integer | Page number (default: 1). Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/portal/consumer/assignment" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Success
Success
{
"success": true,
"data": [
{
"id": "ASG-J5A17Q",
"title": "Assignment",
"isParent": true,
"scheduleTypeLabel": "Multi Day",
"scheduleType": "multi_day",
"startDate": "9/05/2025",
"endDate": "9/06/2025",
"startTime": "11:00 AM",
"endTime": "5:00 PM",
"timezone": null,
"broadcast": null,
"status": {
"id": 1,
"name": "Pending"
},
"serviceProviders": [
{
"id": "SPR-MD5MK3",
"image": "https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg"
}
],
"serviceTypes": [
{
"id": 1,
"label": "ASL"
}
],
"locationType": "Hybrid",
"address": {
"onsite": {
"title": null,
"onSiteType": "manual",
"address": {
"addressLine1": "asas",
"addressLine2": "asas",
"city": "Austin",
"state": null,
"postalCode": "151545"
}
},
"remote": {
"remoteAccessDetails": {
"url": "http://zoom.us/test",
"notes": null,
"meetingPlatform": "Zoom"
}
}
},
"update": "Provider assigned"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 3
}
}Response fields (36)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (29 nested) | |
meta | object (4 nested) |
Nested fields
data 29 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].title | string | Example |
data[].isParent | boolean | Example |
data[].scheduleTypeLabel | string | Example |
data[].scheduleType | string | Example |
data[].startDate | string | Example |
data[].endDate | string | Example |
data[].startTime | string | Example |
data[].endTime | string | Example |
data[].timezone | string or null | |
data[].broadcast | string or null | |
data[].status | object | |
data[].status.id | integer | Example |
data[].status.name | string | Example |
data[].serviceProviders | array of object | |
data[].serviceProviders[].id | string | Example |
data[].serviceProviders[].image | string | Example |
data[].serviceTypes | array of object | |
data[].serviceTypes[].id | integer | Example |
data[].serviceTypes[].label | string | Example |
data[].locationType | string | Example |
data[].address | object | |
data[].address.onsite | object | |
data[].address.onsite.title | string or null | |
data[].address.onsite.onSiteType | string | Example |
data[].address.onsite.address | object | |
data[].address.remote | object | |
data[].address.remote.remoteAccessDetails | object | |
data[].update | string or null | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request — also returned when client is not associated with the authenticated consumer
{
"success": false,
"message": "You don't have access to this client. Please select one from your client list.",
"errors": "Failed to retrieve."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string | Example |
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 '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 |
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
Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Unexpected error occurred"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |