Get Assignment Summary Tab Details
GET /v1/assignment-summary/{id}/{tab}
- Scope
assignments:read- Roles
- admin, scheduler
Retrieve assignment details for a specific tab (summary, historyLogs, insights) for the given tenant. Without Finance Read the money figures are null: the parent summary's totalRevenue, each assigned provider's estimatedPay and the insights' estimatedCost.total; each provider's rates is empty.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Assignment ID Example |
tab required | string | Tab name for which assignment details are requested One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search the audit log. Applies to the |
sortBy | string | Sort column (default: created_at). Applies to the Example |
sortOrder | string | Sort direction (default: desc). Applies to the One of: |
perPage | integer | Rows per page (default: 10). Applies to the Example |
page | integer | Page number (default: 1). Applies to the Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/assignment-summary/{id}/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Assignment details retrieved successfully
Assignment details retrieved successfully
{
"success": true,
"message": "Assignment details retrieved successfully.",
"data": {}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | Assignment details depend on the selected tab |
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 |
404 Not found
Assignment not found
{
"success": false,
"message": "Assignment not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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
Unexpected server error
{
"success": false,
"message": "An unexpected error occurred — please try again."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |