API reference › Restricted lists › Restricted list
Retrieve a single block list entry by ID
GET /v1/settings/portal/block-list/{block_list}
- Scope
settings_restricted_users:read- Roles
- client, consumer, service-provider
Returns details of a specific block list entry including who blocked whom, their roles, profile images, notes, and date.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
block_list required | integer | The ID of the block list entry Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/portal/block-list/{block_list}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Block List entry retrieved successfully
Block List entry retrieved successfully
{
"success": true,
"message": "Block List entry retrieved.",
"data": {
"id": 1,
"blockedUser": {
"id": "CSM-5W5RVY",
"label": "ABC"
},
"blockedUserRoleName": "admin",
"blockedRole": {
"id": 1,
"label": "Example label",
"slug": "example-slug"
},
"blockedUserImage": "https://cdn.example.com/image.png",
"blockedUserOnlineStatus": "online",
"notes": "Added by the scheduler.",
"isBehalfOfOrg": true
}
}Response fields (16)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.blockedUser | object | |
data.blockedUser.id | string | Example |
data.blockedUser.label | string | Example |
data.blockedUserRoleName | string or null | 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.blockedUserImage | string or null | Example |
data.blockedUserOnlineStatus | string | Example |
data.notes | string or null | Example |
data.isBehalfOfOrg | boolean | Example |
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 |
404 Not found
Block List entry not found
{
"success": false,
"message": "Block List entry not found.",
"errors": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string |
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 |