API reference › Assignments › Client portal

Retrieve paginated client assignments with optional filters

GET /v1/portal/client/assignment

Scope
assignments:read
Roles
client

Fetch a paginated list of client 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

consumerstring

Filter by consumer ID. Must be a consumer associated with the authenticated client — otherwise the request is rejected with a 400.

Example CSM-YWUOOH.

statusinteger

Filter by assignment-status ID. Statuses are tenant-configurable rows, not a fixed vocabulary.

Example 1.

customTabstring

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

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

startDatestring (date)

Example 2025-09-12.

endDatestring (date)

Example 2025-09-12.

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.

pageinteger

Page number (default: 1).

Example 1.

requestSourcestring

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

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

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

Example request

Shell
curl "https://api.fetchfido.ai/v1/portal/client/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-XY9EML",
      "title": "Example title",
      "parentTitle": "Example title",
      "parentId": "string",
      "parentScheduleTypeLabel": "Example label",
      "isParent": true,
      "childCount": "string",
      "scheduleTypeLabel": "Example label",
      "scheduleType": "one_time",
      "duration": 0,
      "status": {
        "id": 1,
        "label": "Example label"
      },
      "priority": {
        "id": 1,
        "label": "Example label"
      },
      "broadcast": {
        "id": "string",
        "label": "Example label"
      },
      "providers": [
        null
      ],
      "serviceProviders": [
        null
      ],
      "groupedProvider": [
        null
      ],
      "locationType": "string",
      "address": {
        "locationType": "string"
      },
      "serviceTypes": "string",
      "estimatedCost": "string",
      "finalCost": "string",
      "update": "string",
      "consumers": [
        null
      ],
      "groupedConsumer": "string",
      "createdBy": "string",
      "requestorName": "Example name",
      "requestedVia": "string",
      "restrictedActionButtons": "string",
      "clients": "string"
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "perPage": 10,
    "total": 2
  }
}
Response fields (43)

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

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 36 fields
FieldTypeDescription
data[].idstring

Example ASG-XY9EML.

data[].titlestring or null

Example Example title.

data[].parentTitlestring or null

Example Example title.

data[].parentIdstring or null
data[].parentScheduleTypeLabelstring or null

Example Example label.

data[].isParentboolean

Example true.

data[].childCountstring or null
data[].scheduleTypeLabelstring or null

Example Example label.

data[].scheduleTypestring or null

Example one_time.

data[].durationnumber or null

Example 0.

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

Example 1.

data[].status.labelstring or null

Example Example label.

data[].priorityobject or null
data[].priority.idinteger or null

Example 1.

data[].priority.labelstring or null

Example Example label.

data[].broadcastobject or null
data[].broadcast.idstring or null
data[].broadcast.labelstring or null

Example Example label.

data[].providersarray of any
data[].serviceProvidersarray of any or null
data[].groupedProviderarray of any or null
data[].locationTypestring or null
data[].addressobject or null
data[].address.locationTypestring
data[].serviceTypesstring or null
data[].estimatedCoststring
data[].finalCoststring
data[].updatestring
data[].consumersarray of any or null
data[].groupedConsumerstring or null
data[].createdBystring or null
data[].requestorNamestring or null

Example Example name.

data[].requestedViastring or null
data[].restrictedActionButtonsstring
data[].clientsstring
meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 2.

400 Bad request

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

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

Example false.

messagestring

Example You don't have access to this consumer. Please select one from your consumer 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.