API reference › Assignments › Consumer portal

Retrieve paginated consumer assignments with optional filters

GET /v1/portal/consumer/assignment

Scope
assignments:read
Roles
consumer

Fetch a paginated list of consumer assignments. Supports searching, filtering, and sorting.

Parameters

Query parameters

NameTypeDescription
searchstring

Search keyword

columnsstring

Comma-separated list of searchable columns

sortBystring

Column to sort by

Example created_at.

sortOrderstring

Sort order

One of: asc, desc.

perPageinteger

Items per page

Example 10.

locationTypestring

Filter by location type

One of: Onsite, Remote, Hybrid.

serviceTypesarray of integer

Filter by service type IDs

clientstring

Filter by client

statusstring

Filter by assignment status

One of: Pending, Approved, Rejected, Assigned, No Show.

startDatestring (date)

Example 2025-09-12.

endDatestring (date)

Example 2025-09-12.

requestSourcestring

Filter by the Request Source column (origin of the request).

One of: client-portal, consumer-portal, scheduler, public-assistant. Example client-portal.

startTimestring (time)

Filter assignments whose scheduled time range overlaps this start time (HH:MM:SS). Pairs with endTime; an overnight range (startTime later than endTime) is handled as spanning midnight.

Example 09:00:00.

endTimestring (time)

Filter assignments whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime.

Example 17:00:00.

priorityinteger

Filter by priority id.

Example 2.

customTabstring

Preset filter tab, applied in addition to any other filters.

One of: active, archived, past, upcoming, need_attention. Example active.

pageinteger

Page number (default: 1).

Example 1.

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/portal/consumer/assignment" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Success

Success

JSON
{
  "success": true,
  "data": [
    {
      "id": "ASG-J5A17Q",
      "title": "Assignment",
      "isParent": true,
      "scheduleTypeLabel": "Multi Day",
      "scheduleType": "multi_day",
      "startDate": "9/05/2025",
      "endDate": "9/06/2025",
      "startTime": "11:00 AM",
      "endTime": "5:00 PM",
      "timezone": null,
      "broadcast": null,
      "status": {
        "id": 1,
        "name": "Pending"
      },
      "serviceProviders": [
        {
          "id": "SPR-MD5MK3",
          "image": "https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg"
        }
      ],
      "serviceTypes": [
        {
          "id": 1,
          "label": "ASL"
        }
      ],
      "locationType": "Hybrid",
      "address": {
        "onsite": {
          "title": null,
          "onSiteType": "manual",
          "address": {
            "addressLine1": "asas",
            "addressLine2": "asas",
            "city": "Austin",
            "state": null,
            "postalCode": "151545"
          }
        },
        "remote": {
          "remoteAccessDetails": {
            "url": "http://zoom.us/test",
            "notes": null,
            "meetingPlatform": "Zoom"
          }
        }
      },
      "update": "Provider assigned"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 3
  }
}
Response fields (36)

3 top-level fields; 2 hold nested fields, listed below.

FieldTypeDescription
successboolean

Example true.

dataarray of object (29 nested)
metaobject (4 nested)

Nested fields

data 29 fields
FieldTypeDescription
data[].idstring

Example ASG-J5A17Q.

data[].titlestring

Example Assignment.

data[].isParentboolean

Example true.

data[].scheduleTypeLabelstring

Example Multi Day.

data[].scheduleTypestring

Example multi_day.

data[].startDatestring

Example 9/05/2025.

data[].endDatestring

Example 9/06/2025.

data[].startTimestring

Example 11:00 AM.

data[].endTimestring

Example 5:00 PM.

data[].timezonestring or null
data[].broadcaststring or null
data[].statusobject
data[].status.idinteger

Example 1.

data[].status.namestring

Example Pending.

data[].serviceProvidersarray of object
data[].serviceProviders[].idstring

Example SPR-MD5MK3.

data[].serviceProviders[].imagestring

Example https://d3t50b2fzyr6w1.cloudfront.net/service_providers/SPR-MD5MK3/logo/689492853dac8_Test.jpg.

data[].serviceTypesarray of object
data[].serviceTypes[].idinteger

Example 1.

data[].serviceTypes[].labelstring

Example ASL.

data[].locationTypestring

Example Hybrid.

data[].addressobject
data[].address.onsiteobject
data[].address.onsite.titlestring or null
data[].address.onsite.onSiteTypestring

Example manual.

data[].address.onsite.addressobject
data[].address.remoteobject
data[].address.remote.remoteAccessDetailsobject
data[].updatestring or null

Example Provider assigned.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 3.

400 Bad request

Bad Request — also returned when client is not associated with the authenticated consumer

JSON
{
  "success": false,
  "message": "You don't have access to this client. Please select one from your client list.",
  "errors": "Failed to retrieve."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have access to this client. Please select one from your client list..

errorsstring

Example Failed to retrieve..

401 Not signed in

Missing, invalid or expired API key.

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 .

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

Server Error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected error occurred"
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Unexpected error occurred.