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
| Name | Type | Description |
|---|---|---|
search | string | Search query to filter request by name, email, or request Id. Example |
location | string | Filter request by location ID. Example |
duration | integer | Filter request by duration. Example |
serviceTypes | integer | Filter request by service Types ID. Example |
requestedBy | string | Filter request by requester. Example |
client | string | Filter assignment by client ID. Example |
sortBy | string | Sort clients by a specific field (e.g., 'name', 'created_at'). Example |
sortOrder | string | Sorting order: ascending ('asc') or descending ('desc'). One of: |
columns | string | Search query within visible column content. Example |
startDate | string (date) | Filter clients created on or after this date (YYYY-MM-DD). |
endDate | string (date) | Filter clients created on or before this date (YYYY-MM-DD). |
startTime | string (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. |
endTime | string (time) | Filter requests whose scheduled time range overlaps this end time (HH:MM:SS). Pairs with startTime. |
customTab | string | Preset filter tab, applied in addition to any other filters. One of: |
isPublished | string | Filter by publish state: One of: |
status | integer | Filter by request status id. Example |
localSearch | string | The table's own search box: matches only the columns named in |
perPage | integer | Rows per page (default: 10). Example |
page | integer | Page number (default: 1). Example |
requestSource | string | Filter by the Request Source column (origin of the request). One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (18 nested) | |
meta | object (4 nested) |
Nested fields
data 18 fields
| Field | Type | Description |
|---|---|---|
data[].startDate | string or null | Example |
data[].endDate | string or null | Example |
data[].startTime | string or null | Example |
data[].endTime | string or null | Example |
data[].convertedStartDate | string | Example |
data[].convertedEndDate | string | Example |
data[].convertedStartTime | string | Example |
data[].convertedEndTime | string | Example |
data[].userTimezone | string or null | Example |
data[].timezone | string or null | Example |
data[].assignmentDateTooltip | string | Example |
data[].userDateTooltip | string | Example |
data[].requestedOn | string | Example |
data[].submissionDate | string | Example |
data[].timeSlots | object or null | |
data[].timeSlots.id | integer | Example |
data[].timeSlots.startTime | string | Example |
data[].timeSlots.endTime | string | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
400 Bad request
Bad Request - Invalid query parameters
{
"success": false,
"message": "Invalid parameters. Ensure all required filters are correct."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal Server Error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |