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
| 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 |
consumer | string | Filter assignment by consumer 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 | Filter requests starting on or after this time (HH:MM). Example |
endTime | string | Filter requests ending on or before this time (HH:MM). Example |
page | integer | Page number to retrieve. Example |
perPage | integer | Number of records per page. Example |
status | integer | Filter requests by request-status ID. Example |
isPublished | boolean | Filter requests by their Published status. Example |
customTab | string | Filter requests by tab: 'active', 'archived', 'upcoming', or 'past'. One of: |
localSearch | string | The table's own search box: matches only the columns named in |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
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
{
"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.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (32 nested) | |
meta | object (4 nested) |
Nested fields
data 32 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].title | string or null | Example |
data[].parentTitle | string or null | Example |
data[].parentId | string or null | |
data[].parentScheduleTypeLabel | string or null | Example |
data[].requestorName | string or null | Example |
data[].requestorEmail | string or null | Example |
data[].requestorPhone | string or null | Example |
data[].requestedVia | string or null | |
data[].createdBy | string or null | |
data[].assignTo | string or null | |
data[].isParent | boolean | Example |
data[].scheduleTypeLabel | string or null | Example |
data[].scheduleType | string or null | Example |
data[].duration | number or null | Example |
data[].status | object or null | |
data[].status.id | integer | Example |
data[].status.label | string | Example |
data[].locationType | string or null | |
data[].address | object | |
data[].address.onsite | string | |
data[].address.remote | string | |
data[].serviceTypes | object or null | |
data[].serviceTypes.id | integer | Example |
data[].serviceTypes.label | string | Example |
data[].isPublished | boolean | Example |
data[].consumers | array of any or null | |
data[].priority | object or null | |
data[].priority.id | integer | Example |
data[].priority.label | string | Example |
data[].groupedConsumer | string | |
data[].isPast | boolean | 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 |