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

NameTypeDescription
id requiredstring

Unique identifier of the assignment

Example ASG-J5A17Q-C1.

tab requiredstring

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

One of: details, providers, requirement_and_preferences, document_notes, sidebar. Example details.

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

Example request

Shell
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

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

FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment details retrieved successfully..

dataobject (38 nested)

Nested fields

data 38 fields
FieldTypeDescription
data.assignmentDetailsobject
data.assignmentDetails.idstring

Example ASG-J5A17Q-C1.

data.assignmentDetails.titlestring

Example Assignment.

data.assignmentDetails.descriptionstring

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

data.assignmentDetails.timezonestring or null
data.assignmentDetails.durationinteger

Example 0.

data.assignmentDetails.statusobject
data.assignmentDetails.status.idinteger

Example 5.

data.assignmentDetails.status.labelstring

Example Scheduled.

data.assignmentDetails.scheduleTypeLabelstring

Example one_time.

data.assignmentDetails.locationTypestring

Example hybrid.

data.assignmentDetails.startDatestring

Example 9/05/2025.

data.assignmentDetails.endDatestring

Example 9/05/2025.

data.assignmentDetails.startTimestring

Example 11:00 AM.

data.assignmentDetails.endTimestring

Example 5:00 PM.

data.onSiteContactobject
data.onSiteContact.titlestring

Example On-Site Contact.

data.onSiteContact.namestring

Example asasas.

data.onSiteContact.emailstring

Example user@example.com.

data.onSiteContact.phonestring

Example 454544545.

data.onSiteContact.countryCodestring

Example +1.

data.onSiteContact.phoneTypestring

Example sms_and_voice.

data.onSiteContact.phoneExtensionstring or null
data.onSiteContact.logostring or null
data.assignmentLocationobject
data.assignmentLocation.locationTypestring

Example hybrid.

data.assignmentLocation.onsiteobject
data.assignmentLocation.onsite.locationTypestring

Example On-Site.

data.assignmentLocation.onsite.titlestring or null
data.assignmentLocation.onsite.onSiteTypestring

Example manual.

data.assignmentLocation.onsite.addressobject
data.assignmentLocation.onsite.location_notestring or null
data.assignmentLocation.onsite.serviceProvidersarray of object
data.assignmentLocation.remoteobject
data.assignmentLocation.remote.locationTypestring

Example Remote.

data.assignmentLocation.remote.remoteAccessDetailsobject
data.assignmentLocation.remote.serviceProvidersarray of object
data.childAssignmentIdsstring or null
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..