API reference › Requests › Consumer portal

Retrieve a list of requests

GET /v1/settings/portal/consumer/requests

Scope
requests:read
Roles
consumer

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.

clientstring

Filter assignment by client ID.

Example CLT-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 (time)

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

endTimestring (time)

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

customTabstring

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

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

isPublishedstring

Filter by publish state: true for published requests, false for drafts. Omit for both.

One of: true, false. Example true.

statusinteger

Filter by request status id.

Example 1.

localSearchstring

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

perPageinteger

Rows per page (default: 10).

Example 10.

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/settings/portal/consumer/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": [
    {
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "startTime": "09:00:00",
      "endTime": "09:00:00",
      "convertedStartDate": "2026-01-15",
      "convertedEndDate": "2026-01-15",
      "convertedStartTime": "09:00:00",
      "convertedEndTime": "09:00:00",
      "userTimezone": "America/New_York",
      "timezone": "America/New_York",
      "assignmentDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
      "userDateTooltip": "Jan 15, 2026 9:00 AM – 11:00 AM",
      "requestedOn": "2026-01-15",
      "submissionDate": "2026-01-15",
      "timeSlots": {
        "id": 1,
        "startTime": "09:00:00",
        "endTime": "09:00:00"
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 5,
    "perPage": 10,
    "total": 50
  }
}
Response fields (25)

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

FieldTypeDescription
successboolean

Example true.

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

Nested fields

data 18 fields
FieldTypeDescription
data[].startDatestring or null

Example 2026-01-15.

data[].endDatestring or null

Example 2026-01-15.

data[].startTimestring or null

Example 09:00:00.

data[].endTimestring or null

Example 09:00:00.

data[].convertedStartDatestring

Example 2026-01-15.

data[].convertedEndDatestring

Example 2026-01-15.

data[].convertedStartTimestring

Example 09:00:00.

data[].convertedEndTimestring

Example 09:00:00.

data[].userTimezonestring or null

Example America/New_York.

data[].timezonestring or null

Example America/New_York.

data[].assignmentDateTooltipstring

Example Jan 15, 2026 9:00 AM – 11:00 AM.

data[].userDateTooltipstring

Example Jan 15, 2026 9:00 AM – 11:00 AM.

data[].requestedOnstring

Example 2026-01-15.

data[].submissionDatestring

Example 2026-01-15.

data[].timeSlotsobject or null
data[].timeSlots.idinteger

Example 1.

data[].timeSlots.startTimestring

Example 09:00:00.

data[].timeSlots.endTimestring

Example 09:00:00.

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