API reference › Assignments

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

NameTypeDescription
id requiredstring

Assignment ID

Example ASG-12345.

tab requiredstring

Tab name for which assignment details are requested

One of: summary, historyLogs, insights. Example summary.

Query parameters

NameTypeDescription
searchstring

Search the audit log. Applies to the historyLogs tab only.

sortBystring

Sort column (default: created_at). Applies to the historyLogs tab only.

Example created_at.

sortOrderstring

Sort direction (default: desc). Applies to the historyLogs tab only.

One of: asc, desc. Example desc.

perPageinteger

Rows per page (default: 10). Applies to the historyLogs tab only.

Example 10.

pageinteger

Page number (default: 1). Applies to the historyLogs tab only.

Example 1.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Assignment details retrieved successfully.",
  "data": {}
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment details retrieved successfully..

dataobject

Assignment details depend on the selected tab

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'assignments:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment not found

JSON
{
  "success": false,
  "message": "Assignment not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Assignment not found..

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Unexpected server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..