API reference › Assignments › Client portal
Retrieve specific tab details of client assignment
GET /v1/portal/client/assignment/{tab}/{id}
- Scope
assignments:read- Roles
- client
Fetches the details for a specific tab within an assignment, based on the provided assignment ID and tab identifier. The response structure varies depending on the tab parameter. Supported tabs: 'details', 'providers', 'requirement_and_preferences', 'document_notes', 'sidebar', 'provider_stats', 'summary', 'historyLogs', 'finance'.
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','provider_stats','summary','historyLogs','finance') One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search the audit log. Applies to the |
columns | string | Comma-separated columns the search is limited to. 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/portal/client/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. Note: Response structure varies by tab parameter. The properties below show examples for 'details' tab. For 'finance' tab, see the finance-specific properties documented below.
{
"success": true,
"message": "Assignment details retrieved successfully.",
"data": {
"id": "ASG-J5A17Q-C2",
"title": "Assignment",
"description": "Manage assignment details, including clients, providers, service locations, and access instructions",
"requestorName": "Requestor name",
"requestorEmail": "user@example.com",
"requestorPhone": "9293091253",
"requestorCountryCode": "+1",
"requestorPhoneType": "sms_and_voice",
"requestorPhoneExtension": null,
"assignTo": "client",
"client": {
"id": "CLT-GGM6R1",
"label": "Client1"
},
"newClient": null,
"newConsumer": null,
"consumer": {
"id": "CSM-YWUOOH",
"label": "Consumer1"
},
"location": {
"locationType": "hybrid",
"onsite": {
"onSiteType": "manual",
"organizationLocationId": null,
"clientLocationId": null,
"manualLocation": {
"addressLine1": "asas",
"addressLine2": "asas",
"city": "Austin",
"state": {
"id": 2,
"label": "Alaska (AK)"
},
"postalCode": "151545",
"accessInstruction": null
},
"manualLocationContact": {
"contactName": "asasas",
"contactEmail": "user@example.com",
"contactCountryCode": "+1",
"contactPhone": "454544545",
"contactPhoneType": "sms_and_voice",
"contactPhoneExtension": null
},
"serviceTypes": [
{
"id": 1,
"label": "ASL"
}
],
"serviceTypeBreakdown": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"providerTypeBreakdown": null
}
]
},
"remote": {
"meetingPlatform": "Zoom",
"meetingLink": "http://zoom.us/test",
"meetingCountryCode": "+1",
"meetingPhone": "2025550147",
"meetingExtension": "204",
"accessInstruction": null,
"serviceTypes": [
{
"id": 1,
"label": "ASL"
}
],
"serviceTypeBreakdown": [
{
"serviceTypeId": 1,
"totalProviders": 2,
"providerTypeBreakdown": null
}
]
}
},
"timezone": null,
"duration": 0,
"scheduleType": "one_time",
"childAssignmentIds": null,
"oneTime": {
"dateTimeSlots": [
{
"startDate": "2025-09-06",
"endDate": "2025-09-06",
"timeSlots": [
null
]
}
]
},
"multiDay": {
"dateTimeSlots": [
{}
]
},
"recurring": {
"dateTimeSlots": [
{}
]
},
"chargesSummary": [
{
"rate": "25.00",
"billingServiceRate": "Standard",
"totalBilledAmount": "400.00",
"status": "Pending"
}
],
"lineItems": [
{
"type": {
"id": "charge",
"label": "Charge"
},
"item": "Additional Service",
"description": "Extra service charge",
"amount": "100.00"
}
],
"billingSummary": {
"taxPercentage": 5,
"discountPercentage": 5,
"subtotal": "120.00",
"serviceCharges": "100.00",
"expensesTotal": "15.00",
"additionalItems": "5.00",
"organizationAdminFee": "5.00",
"providerAdminFee": "3.00",
"totalAdminFee": "8.00",
"credits": "50.00",
"taxAmount": "8.50",
"totalAmount": "228.50",
"invoices": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"link": "https://tenant.example.com/finances/invoices/550e8400-e29b-41d4-a716-446655440000"
}
]
},
"assignmentDurationAndCost": {
"estimatedCostBreakdown": [
{
"serviceType": "ASL",
"serviceProviderType": "ASL Interpreter",
"rateType": "standard",
"siteType": "onsite",
"hours": 8,
"rate": 30,
"cost": 240,
"minimum_applied": true,
"minimum_duration": 12
}
],
"totalDuration": "8 hours",
"totalCost": "240.00"
},
"terminalChargeMode": "canceled",
"chargeSource": "cancellation_fee",
"billableServiceCharges": "75.00",
"billableSubtotal": "95.00",
"cancellationFee": "75.00",
"noShowFee": "50.00",
"expenses": {
"items": [
{
"id": 1,
"name": "Mileage",
"rate": 0.67,
"unit": "mile"
}
],
"total": 0
},
"expenseBreakdownByProvider": {
"providers": [
{
"service_provider_id": "USR-ABC123",
"providerName": "Jane Provider",
"image": "https://example.com/provider-logo.jpg",
"total": "25.00",
"approved_total": "10.00",
"expenseApproveEnabled": true,
"items": [
null
]
}
],
"total": "25.00",
"approved_total": "10.00"
}
}
}Response fields (118)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object (115 nested) | Response structure varies by tab. Properties below are for 'details' tab. For 'finance' and 'summary' tabs, see billingSummary and lineItems (same invoice-style billing data on both). Finance tab also includes chargesSummary and assignmentDurationAndCost. |
Nested fields
data 115 fields
| Field | Type | Description |
|---|---|---|
data.id | string | Example |
data.title | string | Example |
data.description | string | Example |
data.requestorName | string | Example |
data.requestorEmail | string | Example |
data.requestorPhone | string | Example |
data.requestorCountryCode | string | Example |
data.requestorPhoneType | string | Example |
data.requestorPhoneExtension | string or null | |
data.assignTo | string | Example |
data.client | object | |
data.client.id | string | Example |
data.client.label | string | Example |
data.newClient | string or null | |
data.newConsumer | string or null | |
data.consumer | object | |
data.consumer.id | string | Example |
data.consumer.label | string | Example |
data.location | object | |
data.location.locationType | string | Example |
data.location.onsite | object | |
data.location.onsite.onSiteType | string | Example |
data.location.onsite.organizationLocationId | string or null | |
data.location.onsite.clientLocationId | string or null | |
data.location.onsite.manualLocation | object | |
data.location.onsite.manualLocationContact | object | |
data.location.onsite.serviceTypes | array of object | |
data.location.onsite.serviceTypeBreakdown | array of object | |
data.location.remote | object | |
data.location.remote.meetingPlatform | string | Example |
data.location.remote.meetingLink | string | Example |
data.location.remote.meetingCountryCode | string | Example |
data.location.remote.meetingPhone | string | Dial-in number; replaces meetingLink when meetingPlatform is Phone. Example |
data.location.remote.meetingExtension | string or null | Example |
data.location.remote.accessInstruction | string or null | |
data.location.remote.serviceTypes | array of object | |
data.location.remote.serviceTypeBreakdown | array of object | |
data.timezone | string or null | |
data.duration | integer | Example |
data.scheduleType | string | Example |
data.childAssignmentIds | string or null | |
data.oneTime | object | |
data.oneTime.dateTimeSlots | array of object | |
data.oneTime.dateTimeSlots[].startDate | string | Example |
data.oneTime.dateTimeSlots[].endDate | string | Example |
data.oneTime.dateTimeSlots[].timeSlots | array of object | |
data.multiDay | object | |
data.multiDay.dateTimeSlots | array of object | |
data.recurring | object | |
data.recurring.dateTimeSlots | array of object | |
data.chargesSummary | array of object | For 'finance' tab: Array of charge summaries |
data.chargesSummary[].rate | string | Example |
data.chargesSummary[].billingServiceRate | string | Example |
data.chargesSummary[].totalBilledAmount | string | Example |
data.chargesSummary[].status | string | Example |
data.lineItems | array of object | For 'finance' tab: Array of invoice line items |
data.lineItems[].type | object | |
data.lineItems[].type.id | string | Example |
data.lineItems[].type.label | string | Example |
data.lineItems[].item | string | Example |
data.lineItems[].description | string | Example |
data.lineItems[].amount | string | Example |
data.billingSummary | object | For 'finance' tab: Billing summary with totals and calculations (subtotal aligns with invoice document subtotal; admin fees from AR work-item charges for this client) |
data.billingSummary.taxPercentage | number (float) | Example |
data.billingSummary.discountPercentage | number (float) | Example |
data.billingSummary.subtotal | string | Prorated invoice subtotal (pre-tax gross) for this work item Example |
data.billingSummary.serviceCharges | string | Prorated invoice services_charges for this work item, or estimated service total when no invoice Example |
data.billingSummary.expensesTotal | string | Prorated invoice expenses_total when invoiced; AR expense total when no invoice (client-billed) Example |
data.billingSummary.additionalItems | string | When invoiced: prorated line-charge slice (subtotal minus services, expenses_total, and total_admin_fee). When no invoice: 0 Example |
data.billingSummary.organizationAdminFee | string | Organization admin fee from AR charge build for this work item (0 when bill-to organization) Example |
data.billingSummary.providerAdminFee | string | Provider admin fee from AR charge build (0 when bill-to organization) Example |
data.billingSummary.totalAdminFee | string | organizationAdminFee + providerAdminFee from AR charge build Example |
data.billingSummary.credits | string | Example |
data.billingSummary.taxAmount | string | Example |
data.billingSummary.totalAmount | string | Example |
data.billingSummary.invoices | array of object | Linked invoices for this client and work item (newest issue date first). |
data.billingSummary.invoices[].id | string (uuid) | Example |
data.billingSummary.invoices[].link | string | Example |
data.assignmentDurationAndCost | object | For 'finance' tab: Assignment duration and cost breakdown |
data.assignmentDurationAndCost.estimatedCostBreakdown | array of object | Breakdown of estimated costs by service type, rate type and site type |
data.assignmentDurationAndCost.estimatedCostBreakdown[].serviceType | string | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].serviceProviderType | string | Provider type this line is rated for; empty string when the line is not scoped to one. Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].rateType | string | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].siteType | string | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].hours | number | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].rate | number (float) | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].cost | number (float) | Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].minimum_applied | boolean | True when the billed duration was floored up to the minimum billing duration. Example |
data.assignmentDurationAndCost.estimatedCostBreakdown[].minimum_duration | number (float) or null | Minimum billing duration on the same basis as duration; null when no minimum applies to this line. Example |
data.assignmentDurationAndCost.totalDuration | string | Example |
data.assignmentDurationAndCost.totalCost | string | Example |
data.terminalChargeMode | string | Present only when work item is canceled or no-show, client is not org-billed, and no posted invoice exists for this client. Indicates which terminal billing rules applied. One of: |
data.chargeSource | string | AR charge source for this client (e.g. cancellation_fee, no_show_client_split, service_charge). Present with terminalChargeMode. Example |
data.billableServiceCharges | string | Billable service amount for this client under terminal rules. Present with terminalChargeMode. Example |
data.billableSubtotal | string | Pre-tax gross: billableServiceCharges + approved client expenses + admin fees. Present with terminalChargeMode. Example |
data.cancellationFee | string or null | This client's cancellation fee total when terminalChargeMode is canceled; otherwise omitted or null. Example |
data.noShowFee | string or null | Stored no-show fee for this client when terminalChargeMode is no_show and client is selected; otherwise omitted or null. Example |
data.expenses | object | Reimbursable expenses for the assignment (same format as work item expenses) |
data.expenses.items | array of object | |
data.expenses.items[].id | integer | Example |
data.expenses.items[].name | string | Example |
data.expenses.items[].rate | number (float) | Example |
data.expenses.items[].unit | string | Example |
data.expenses.total | number (float) | Example |
data.expenseBreakdownByProvider | object | Per-provider client expense breakdown (additive). Use this for approve/decline actions when multiple providers are on the work item. Legacy expenseBreakdown remains aggregated. |
data.expenseBreakdownByProvider.providers | array of object | |
data.expenseBreakdownByProvider.providers[].service_provider_id | string | Example |
data.expenseBreakdownByProvider.providers[].providerName | string | Example |
data.expenseBreakdownByProvider.providers[].image | string or null | Example |
data.expenseBreakdownByProvider.providers[].total | string | Example |
data.expenseBreakdownByProvider.providers[].approved_total | string | Example |
data.expenseBreakdownByProvider.providers[].expenseApproveEnabled | boolean | True when the client can approve at least one expense in this provider's block under the current expense approval workflow. Example |
data.expenseBreakdownByProvider.providers[].items | array of object | |
data.expenseBreakdownByProvider.total | string | Example |
data.expenseBreakdownByProvider.approved_total | 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 |