API reference › Assignments › Consumer portal
Retrieve specific tab details of consumer assignment
GET /v1/portal/consumer/assignment/{tab}/{id}
- Scope
assignments:read- Roles
- consumer
Fetches the details for a specific tab within an 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','requirement_and_preferences','document_notes','sidebar') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/portal/consumer/assignment/{tab}/{id}" \
-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": {
"assignmentDetails": {
"id": "ASG-J5A17Q-C1",
"title": "Assignment",
"description": "Manage assignment details, including clients, providers, service locations, and access instructions",
"timezone": null,
"duration": 0,
"status": {
"id": 5,
"label": "Scheduled"
},
"scheduleTypeLabel": "one_time",
"locationType": "hybrid",
"startDate": "9/05/2025",
"endDate": "9/05/2025",
"startTime": "11:00 AM",
"endTime": "5:00 PM"
},
"onSiteContact": {
"title": "On-Site Contact",
"name": "asasas",
"email": "user@example.com",
"phone": "454544545",
"countryCode": "+1",
"phoneType": "sms_and_voice",
"phoneExtension": null,
"logo": null
},
"assignmentLocation": {
"locationType": "hybrid",
"onsite": {
"locationType": "On-Site",
"title": null,
"onSiteType": "manual",
"address": {
"addressLine1": "asas",
"addressLine2": "asas",
"city": "Austin",
"state": {
"id": 2,
"label": "Alaska (AK)"
},
"postalCode": "151545",
"accessInstruction": null
},
"location_note": null,
"serviceProviders": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"serviceType": "ASL",
"assignedProviders": 1
}
]
},
"remote": {
"locationType": "Remote",
"remoteAccessDetails": {
"meetingPlatform": "Zoom",
"url": "http://zoom.us/test",
"notes": null
},
"serviceProviders": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"serviceType": "ASL",
"assignedProviders": 1
}
]
}
},
"childAssignmentIds": null
}
}Response fields (41)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (38 nested) |
Nested fields
data 38 fields
| Field | Type | Description |
|---|---|---|
data.assignmentDetails | object | |
data.assignmentDetails.id | string | Example |
data.assignmentDetails.title | string | Example |
data.assignmentDetails.description | string | Example |
data.assignmentDetails.timezone | string or null | |
data.assignmentDetails.duration | integer | Example |
data.assignmentDetails.status | object | |
data.assignmentDetails.status.id | integer | Example |
data.assignmentDetails.status.label | string | Example |
data.assignmentDetails.scheduleTypeLabel | string | Example |
data.assignmentDetails.locationType | string | Example |
data.assignmentDetails.startDate | string | Example |
data.assignmentDetails.endDate | string | Example |
data.assignmentDetails.startTime | string | Example |
data.assignmentDetails.endTime | string | Example |
data.onSiteContact | object | |
data.onSiteContact.title | string | Example |
data.onSiteContact.name | string | Example |
data.onSiteContact.email | string | Example |
data.onSiteContact.phone | string | Example |
data.onSiteContact.countryCode | string | Example |
data.onSiteContact.phoneType | string | Example |
data.onSiteContact.phoneExtension | string or null | |
data.onSiteContact.logo | string or null | |
data.assignmentLocation | object | |
data.assignmentLocation.locationType | string | Example |
data.assignmentLocation.onsite | object | |
data.assignmentLocation.onsite.locationType | string | Example |
data.assignmentLocation.onsite.title | string or null | |
data.assignmentLocation.onsite.onSiteType | string | Example |
data.assignmentLocation.onsite.address | object | |
data.assignmentLocation.onsite.location_note | string or null | |
data.assignmentLocation.onsite.serviceProviders | array of object | |
data.assignmentLocation.remote | object | |
data.assignmentLocation.remote.locationType | string | Example |
data.assignmentLocation.remote.remoteAccessDetails | object | |
data.assignmentLocation.remote.serviceProviders | array of object | |
data.childAssignmentIds | string or null |
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 |