API reference › Assignments › Provider portal
Retrieve service provider assignments
GET /v1/settings/portal/provider/assignment
- Scope
assignments:read- Roles
- service-provider
Fetches a paginated list of assignments for the authenticated service provider based on filters. Each item adds myTime and myConvertedTime: the provider's own covered hours on that occurrence when they hold only part of a partial-coverage job ('12:00 PM to 4:00 PM', separate runs joined with ', '), null otherwise.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter assignments by name, email, or assignment ID. Example |
status | integer | Filter assignments by status ID. Example |
serviceTypes | integer | Filter assignments by service type ID. Example |
client | string | Filter assignments by client ID. Example |
customTab | string | Filter assignments by custom tab. Example |
startDate | string (date) | Filter assignments starting on or after this date (YYYY-MM-DD). Example |
endDate | string (date) | Filter assignments ending on or before this date (YYYY-MM-DD). Example |
startTime | string | Filter assignments by start time. Example |
endTime | string | Filter assignments by end time. Example |
locationType | string | Filter assignments by location type. Example |
duration | integer | Filter assignments by duration in hours. Example |
distance | number (float) | Filter assignments by distance in miles/km. Example |
sortBy | string | Sort assignments 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 assignments to retrieve per page. Example |
columns | string | Comma-separated list of columns to search within. Example |
partialCover | boolean | Filter by the Partial Cover column: true for work items that allow partial coverage, false for those that do not. 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/settings/portal/provider/assignment" \
-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,
"message": "Assignment List Retrieved!",
"data": [
{
"assignmentId": "ASG-23RT45",
"name": "Assignment Name",
"status": "Active",
"priority": "High"
}
],
"meta": {
"currentPage": 1,
"lastPage": 5,
"perPage": 10,
"total": 50
}
}Response fields (12)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object | |
data[].assignmentId | string | Example |
data[].name | string | Example |
data[].status | string | Example |
data[].priority | string | Example |
meta | object | |
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Failed to retrieve.",
"errors": "Invalid parameters provided."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | 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 |
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": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |