API reference › Assignments › Client portal
Retrieve paginated client assignments with optional filters
GET /v1/portal/client/assignment
- Scope
assignments:read- Roles
- client
Fetch a paginated list of client 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 |
consumer | string | Filter by consumer ID. Must be a consumer associated with the authenticated client — otherwise the request is rejected with a 400. Example |
status | integer | Filter by assignment-status ID. Statuses are tenant-configurable rows, not a fixed vocabulary. Example |
customTab | string | Preset filter tab, applied in addition to any other filters. One of: |
startDate | string (date) | Example |
endDate | string (date) | Example |
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 |
page | integer | Page number (default: 1). Example |
requestSource | string | Filter by the Request Source column (origin of the request). One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/portal/client/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-XY9EML",
"title": "Example title",
"parentTitle": "Example title",
"parentId": "string",
"parentScheduleTypeLabel": "Example label",
"isParent": true,
"childCount": "string",
"scheduleTypeLabel": "Example label",
"scheduleType": "one_time",
"duration": 0,
"status": {
"id": 1,
"label": "Example label"
},
"priority": {
"id": 1,
"label": "Example label"
},
"broadcast": {
"id": "string",
"label": "Example label"
},
"providers": [
null
],
"serviceProviders": [
null
],
"groupedProvider": [
null
],
"locationType": "string",
"address": {
"locationType": "string"
},
"serviceTypes": "string",
"estimatedCost": "string",
"finalCost": "string",
"update": "string",
"consumers": [
null
],
"groupedConsumer": "string",
"createdBy": "string",
"requestorName": "Example name",
"requestedVia": "string",
"restrictedActionButtons": "string",
"clients": "string"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 2
}
}Response fields (43)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (36 nested) | |
meta | object (4 nested) |
Nested fields
data 36 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].title | string or null | Example |
data[].parentTitle | string or null | Example |
data[].parentId | string or null | |
data[].parentScheduleTypeLabel | string or null | Example |
data[].isParent | boolean | Example |
data[].childCount | string or null | |
data[].scheduleTypeLabel | string or null | Example |
data[].scheduleType | string or null | Example |
data[].duration | number or null | Example |
data[].status | object or null | |
data[].status.id | integer or null | Example |
data[].status.label | string or null | Example |
data[].priority | object or null | |
data[].priority.id | integer or null | Example |
data[].priority.label | string or null | Example |
data[].broadcast | object or null | |
data[].broadcast.id | string or null | |
data[].broadcast.label | string or null | Example |
data[].providers | array of any | |
data[].serviceProviders | array of any or null | |
data[].groupedProvider | array of any or null | |
data[].locationType | string or null | |
data[].address | object or null | |
data[].address.locationType | string | |
data[].serviceTypes | string or null | |
data[].estimatedCost | string | |
data[].finalCost | string | |
data[].update | string | |
data[].consumers | array of any or null | |
data[].groupedConsumer | string or null | |
data[].createdBy | string or null | |
data[].requestorName | string or null | Example |
data[].requestedVia | string or null | |
data[].restrictedActionButtons | string | |
data[].clients | string |
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 consumer is not associated with the authenticated client
{
"success": false,
"message": "You don't have access to this consumer. Please select one from your consumer 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 |