API reference › Restricted lists › Restricted list
Retrieve paginated block list with optional filters
GET /v1/block-list
- Scope
settings_restricted_users:read- Roles
- admin, scheduler
Fetch a paginated list of block list entries. Allows filtering, searching, and sorting.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
search | string | Search keyword |
columns | string | Comma-separated list of searchable columns |
sortBy | string | Column to sort by |
sortOrder | string | Sort order One of: |
perPage | integer | Items per page |
clientId | string | Filter by client ID |
consumerId | string | Filter by consumer ID |
serviceProviderId | string | Filter by service provider ID |
startDate | string (date) | |
endDate | string (date) |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/block-list" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Success
Success
{
"success": true,
"data": [
{
"id": 1,
"blockedUser": {
"id": "string",
"label": "Example label",
"onlineStatus": "online"
},
"blockedUserRoleName": "admin",
"blockedUserImage": "https://cdn.example.com/image.png",
"blockedUserOnlineStatus": "online",
"blockedRole": {
"id": 1,
"label": "Example label",
"slug": "example-slug"
},
"notes": "Added by the scheduler.",
"blockedDate": "2026-01-15",
"isBehalfOfOrg": true,
"isBehalfOfRole": "string",
"providerServices": [
null
],
"blockedBy": {
"id": "string",
"label": "Example label"
},
"blockedByOnlineStatus": "online",
"blockedByRoleName": "admin",
"blockedByRole": {
"id": 1,
"label": "Example label",
"slug": "example-slug"
},
"blockedByImage": "https://cdn.example.com/image.png",
"blockedByProviderServices": [
null
]
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 1
}
}Response fields (35)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (28 nested) | |
meta | object (4 nested) |
Nested fields
data 28 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].blockedUser | object or null | |
data[].blockedUser.id | string | |
data[].blockedUser.label | string or null | Example |
data[].blockedUser.onlineStatus | string | Example |
data[].blockedUserRoleName | string or null | Example |
data[].blockedUserImage | string or null | Example |
data[].blockedUserOnlineStatus | string | Example |
data[].blockedRole | object or null | |
data[].blockedRole.id | integer or null | Example |
data[].blockedRole.label | string or null | Example |
data[].blockedRole.slug | string or null | Example |
data[].notes | string | Example |
data[].blockedDate | string | Example |
data[].isBehalfOfOrg | boolean | Example |
data[].isBehalfOfRole | string or null | |
data[].providerServices | array of any or null | |
data[].blockedBy | object or null | |
data[].blockedBy.id | string | |
data[].blockedBy.label | string or null | Example |
data[].blockedByOnlineStatus | string | Example |
data[].blockedByRoleName | string or null | Example |
data[].blockedByRole | object or null | |
data[].blockedByRole.id | integer or null | Example |
data[].blockedByRole.label | string or null | Example |
data[].blockedByRole.slug | string or null | Example |
data[].blockedByImage | string or null | Example |
data[].blockedByProviderServices | array of any or null |
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
{
"success": false,
"message": "Failed to retrieve.",
"errors": {
"search": [
"Invalid search parameter"
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
401 Not signed in
Missing, invalid or expired API key.
{
"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 'settings_restricted_users: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
Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Unexpected error occurred"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |