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

NameTypeDescription
id requiredstring

Unique identifier of the assignment

Example ASM-ZGJ8T2.

tab requiredstring

Identifier for the specific tab to fetch (e.g., 'details','providers','requirement_and_preferences','document_notes','sidebar','provider_stats','summary','historyLogs','finance')

One of: details, providers, requirement_and_preferences, document_notes, sidebar, provider_stats, summary, historyLogs, finance. Example details.

Query parameters

NameTypeDescription
searchstring

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

columnsstring

Comma-separated columns the search is limited to. 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/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.

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment details retrieved successfully..

dataobject (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
FieldTypeDescription
data.idstring

Example ASG-J5A17Q-C2.

data.titlestring

Example Assignment.

data.descriptionstring

Example Manage assignment details, including clients, providers, service locations, and access instructions.

data.requestorNamestring

Example Requestor name.

data.requestorEmailstring

Example user@example.com.

data.requestorPhonestring

Example 9293091253.

data.requestorCountryCodestring

Example +1.

data.requestorPhoneTypestring

Example sms_and_voice.

data.requestorPhoneExtensionstring or null
data.assignTostring

Example client.

data.clientobject
data.client.idstring

Example CLT-GGM6R1.

data.client.labelstring

Example Client1.

data.newClientstring or null
data.newConsumerstring or null
data.consumerobject
data.consumer.idstring

Example CSM-YWUOOH.

data.consumer.labelstring

Example Consumer1.

data.locationobject
data.location.locationTypestring

Example hybrid.

data.location.onsiteobject
data.location.onsite.onSiteTypestring

Example manual.

data.location.onsite.organizationLocationIdstring or null
data.location.onsite.clientLocationIdstring or null
data.location.onsite.manualLocationobject
data.location.onsite.manualLocationContactobject
data.location.onsite.serviceTypesarray of object
data.location.onsite.serviceTypeBreakdownarray of object
data.location.remoteobject
data.location.remote.meetingPlatformstring

Example Zoom.

data.location.remote.meetingLinkstring

Example http://zoom.us/test.

data.location.remote.meetingCountryCodestring

Example +1.

data.location.remote.meetingPhonestring

Dial-in number; replaces meetingLink when meetingPlatform is Phone.

Example 2025550147.

data.location.remote.meetingExtensionstring or null

Example 204.

data.location.remote.accessInstructionstring or null
data.location.remote.serviceTypesarray of object
data.location.remote.serviceTypeBreakdownarray of object
data.timezonestring or null
data.durationinteger

Example 0.

data.scheduleTypestring

Example one_time.

data.childAssignmentIdsstring or null
data.oneTimeobject
data.oneTime.dateTimeSlotsarray of object
data.oneTime.dateTimeSlots[].startDatestring

Example 2025-09-06.

data.oneTime.dateTimeSlots[].endDatestring

Example 2025-09-06.

data.oneTime.dateTimeSlots[].timeSlotsarray of object
data.multiDayobject
data.multiDay.dateTimeSlotsarray of object
data.recurringobject
data.recurring.dateTimeSlotsarray of object
data.chargesSummaryarray of object

For 'finance' tab: Array of charge summaries

data.chargesSummary[].ratestring

Example 25.00.

data.chargesSummary[].billingServiceRatestring

Example Standard.

data.chargesSummary[].totalBilledAmountstring

Example 400.00.

data.chargesSummary[].statusstring

Example Pending.

data.lineItemsarray of object

For 'finance' tab: Array of invoice line items

data.lineItems[].typeobject
data.lineItems[].type.idstring

Example charge.

data.lineItems[].type.labelstring

Example Charge.

data.lineItems[].itemstring

Example Additional Service.

data.lineItems[].descriptionstring

Example Extra service charge.

data.lineItems[].amountstring

Example 100.00.

data.billingSummaryobject

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.taxPercentagenumber (float)

Example 5.

data.billingSummary.discountPercentagenumber (float)

Example 5.

data.billingSummary.subtotalstring

Prorated invoice subtotal (pre-tax gross) for this work item

Example 120.00.

data.billingSummary.serviceChargesstring

Prorated invoice services_charges for this work item, or estimated service total when no invoice

Example 100.00.

data.billingSummary.expensesTotalstring

Prorated invoice expenses_total when invoiced; AR expense total when no invoice (client-billed)

Example 15.00.

data.billingSummary.additionalItemsstring

When invoiced: prorated line-charge slice (subtotal minus services, expenses_total, and total_admin_fee). When no invoice: 0

Example 5.00.

data.billingSummary.organizationAdminFeestring

Organization admin fee from AR charge build for this work item (0 when bill-to organization)

Example 5.00.

data.billingSummary.providerAdminFeestring

Provider admin fee from AR charge build (0 when bill-to organization)

Example 3.00.

data.billingSummary.totalAdminFeestring

organizationAdminFee + providerAdminFee from AR charge build

Example 8.00.

data.billingSummary.creditsstring

Example 50.00.

data.billingSummary.taxAmountstring

Example 8.50.

data.billingSummary.totalAmountstring

Example 228.50.

data.billingSummary.invoicesarray of object

Linked invoices for this client and work item (newest issue date first).

data.billingSummary.invoices[].idstring (uuid)

Example 550e8400-e29b-41d4-a716-446655440000.

data.billingSummary.invoices[].linkstring

Example https://tenant.example.com/finances/invoices/550e8400-e29b-41d4-a716-446655440000.

data.assignmentDurationAndCostobject

For 'finance' tab: Assignment duration and cost breakdown

data.assignmentDurationAndCost.estimatedCostBreakdownarray of object

Breakdown of estimated costs by service type, rate type and site type

data.assignmentDurationAndCost.estimatedCostBreakdown[].serviceTypestring

Example ASL.

data.assignmentDurationAndCost.estimatedCostBreakdown[].serviceProviderTypestring

Provider type this line is rated for; empty string when the line is not scoped to one.

Example ASL Interpreter.

data.assignmentDurationAndCost.estimatedCostBreakdown[].rateTypestring

Example standard.

data.assignmentDurationAndCost.estimatedCostBreakdown[].siteTypestring

Example onsite.

data.assignmentDurationAndCost.estimatedCostBreakdown[].hoursnumber

Example 8.

data.assignmentDurationAndCost.estimatedCostBreakdown[].ratenumber (float)

Example 30.

data.assignmentDurationAndCost.estimatedCostBreakdown[].costnumber (float)

Example 240.

data.assignmentDurationAndCost.estimatedCostBreakdown[].minimum_appliedboolean

True when the billed duration was floored up to the minimum billing duration.

Example true.

data.assignmentDurationAndCost.estimatedCostBreakdown[].minimum_durationnumber (float) or null

Minimum billing duration on the same basis as duration; null when no minimum applies to this line.

Example 12.

data.assignmentDurationAndCost.totalDurationstring

Example 8 hours.

data.assignmentDurationAndCost.totalCoststring

Example 240.00.

data.terminalChargeModestring

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: canceled, no_show. Example canceled.

data.chargeSourcestring

AR charge source for this client (e.g. cancellation_fee, no_show_client_split, service_charge). Present with terminalChargeMode.

Example cancellation_fee.

data.billableServiceChargesstring

Billable service amount for this client under terminal rules. Present with terminalChargeMode.

Example 75.00.

data.billableSubtotalstring

Pre-tax gross: billableServiceCharges + approved client expenses + admin fees. Present with terminalChargeMode.

Example 95.00.

data.cancellationFeestring or null

This client's cancellation fee total when terminalChargeMode is canceled; otherwise omitted or null.

Example 75.00.

data.noShowFeestring or null

Stored no-show fee for this client when terminalChargeMode is no_show and client is selected; otherwise omitted or null.

Example 50.00.

data.expensesobject

Reimbursable expenses for the assignment (same format as work item expenses)

data.expenses.itemsarray of object
data.expenses.items[].idinteger

Example 1.

data.expenses.items[].namestring

Example Mileage.

data.expenses.items[].ratenumber (float)

Example 0.67.

data.expenses.items[].unitstring

Example mile.

data.expenses.totalnumber (float)

Example 0.

data.expenseBreakdownByProviderobject

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.providersarray of object
data.expenseBreakdownByProvider.providers[].service_provider_idstring

Example USR-ABC123.

data.expenseBreakdownByProvider.providers[].providerNamestring

Example Jane Provider.

data.expenseBreakdownByProvider.providers[].imagestring or null

Example https://example.com/provider-logo.jpg.

data.expenseBreakdownByProvider.providers[].totalstring

Example 25.00.

data.expenseBreakdownByProvider.providers[].approved_totalstring

Example 10.00.

data.expenseBreakdownByProvider.providers[].expenseApproveEnabledboolean

True when the client can approve at least one expense in this provider's block under the current expense approval workflow.

Example true.

data.expenseBreakdownByProvider.providers[].itemsarray of object
data.expenseBreakdownByProvider.totalstring

Example 25.00.

data.expenseBreakdownByProvider.approved_totalstring

Example 10.00.

401 Not signed in

Unauthorized - authentication required

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 .

422 Validation failed

Validation error - Missing or invalid parameters

JSON
{
  "success": false,
  "message": "Validation Failed",
  "errors": {
    "id": [
      "The specified assignment does not exist."
    ]
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation Failed.

errorsobject
errors.idarray of string
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

Internal server error

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

Example false.

messagestring

Example An unexpected error occurred. Please try again later..