API reference › Requests › Client portal

Retrieve a list of requests

GET /v1/settings/portal/client/requests

Scope
requests:read
Roles
client

Fetches a paginated list of requests based on search criteria, filters, and sorting options.

Parameters

Query parameters

NameTypeDescription
searchstring

Search query to filter request by name, email, or request Id.

Example request 1.

locationstring

Filter request by location ID.

Example CLTLOC-123.

durationinteger

Filter request by duration.

Example 1.

serviceTypesinteger

Filter request by service Types ID.

Example 1.

requestedBystring

Filter request by requester.

Example consumer.

consumerstring

Filter assignment by consumer ID.

Example CSM-26TR5.

sortBystring

Sort clients by a specific field (e.g., 'name', 'created_at').

Example title.

sortOrderstring

Sorting order: ascending ('asc') or descending ('desc').

One of: asc, desc. Example asc.

columnsstring

Search query within visible column content.

Example title,ID,consumer.

startDatestring (date)

Filter clients created on or after this date (YYYY-MM-DD).

endDatestring (date)

Filter clients created on or before this date (YYYY-MM-DD).

startTimestring

Filter requests starting on or after this time (HH:MM).

Example 09:00.

endTimestring

Filter requests ending on or before this time (HH:MM).

Example 17:00.

pageinteger

Page number to retrieve.

Example 1.

perPageinteger

Number of records per page.

Example 10.

statusinteger

Filter requests by request-status ID.

Example 1.

isPublishedboolean

Filter requests by their Published status.

Example true.

customTabstring

Filter requests by tab: 'active', 'archived', 'upcoming', or 'past'.

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

localSearchstring

The table's own search box: matches only the columns named in columns. search is the global search.

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

Example request

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

Try it

Responses

200 Requests retrieved successfully

Requests retrieved successfully

JSON
{
  "success": true,
  "data": [
    {
      "id": "ASG-XY9EML",
      "title": "Example title",
      "parentTitle": "Example title",
      "parentId": "string",
      "parentScheduleTypeLabel": "Example label",
      "requestorName": "Example name",
      "requestorEmail": "user@example.com",
      "requestorPhone": "+1-555-0142",
      "requestedVia": "string",
      "createdBy": "string",
      "assignTo": "string",
      "isParent": true,
      "scheduleTypeLabel": "Example label",
      "scheduleType": "one_time",
      "duration": 0,
      "status": {
        "id": 1,
        "label": "Example label"
      },
      "locationType": "string",
      "address": {
        "onsite": "string",
        "remote": "string"
      },
      "serviceTypes": {
        "id": 1,
        "label": "Example label"
      },
      "isPublished": true,
      "consumers": [
        null
      ],
      "priority": {
        "id": 1,
        "label": "Example label"
      },
      "groupedConsumer": "string",
      "isPast": true
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (39)

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

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 32 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[].requestorNamestring or null

Example Example name.

data[].requestorEmailstring or null

Example user@example.com.

data[].requestorPhonestring or null

Example +1-555-0142.

data[].requestedViastring or null
data[].createdBystring or null
data[].assignTostring or null
data[].isParentboolean

Example true.

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

Example 1.

data[].status.labelstring

Example Example label.

data[].locationTypestring or null
data[].addressobject
data[].address.onsitestring
data[].address.remotestring
data[].serviceTypesobject or null
data[].serviceTypes.idinteger

Example 1.

data[].serviceTypes.labelstring

Example Example label.

data[].isPublishedboolean

Example true.

data[].consumersarray of any or null
data[].priorityobject or null
data[].priority.idinteger

Example 1.

data[].priority.labelstring

Example Example label.

data[].groupedConsumerstring
data[].isPastboolean

Example true.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 5.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 50.

400 Bad request

Bad Request - Invalid query parameters

JSON
{
  "success": false,
  "message": "Invalid parameters. Ensure all required filters are correct."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid parameters. Ensure all required filters are correct..

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 'requests: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 'requests: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

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..