Retrieve specific tab details of a assignment
GET /v1/assignment/{id}/{tab}
- Scope
assignments:read
Fetches the details for a specific tab within a assignment, based on the provided assignment ID and tab identifier.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Unique identifier of the assignment Example |
tab required | string | Identifier for the specific tab to fetch (e.g., 'details','providers','requirementPreferences','documents','sidebar','providerStats') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/assignment/{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,
"data": {
"id": "ASM-MARH4E",
"title": "Assignment Title"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object | |
data.id | string | Example |
data.title | 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 |
422 Validation failed
Validation error - Missing or invalid parameters
{
"success": false,
"message": "Validation Failed",
"errors": {
"id": [
"The specified assignment does not exist."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.id | array of string |
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": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |