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

NameTypeDescription
block_list requiredinteger

The ID of the block list entry

Example 5.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Block List entry retrieved..

dataobject
data.idinteger

Example 1.

data.blockedUserobject
data.blockedUser.idstring

Example CSM-5W5RVY.

data.blockedUser.labelstring

Example ABC.

data.blockedUserRoleNamestring or null

Example admin.

data.blockedRoleobject or null
data.blockedRole.idinteger or null

Example 1.

data.blockedRole.labelstring or null

Example Example label.

data.blockedRole.slugstring or null

Example example-slug.

data.blockedUserImagestring or null

Example https://cdn.example.com/image.png.

data.blockedUserOnlineStatusstring

Example online.

data.notesstring or null

Example Added by the scheduler..

data.isBehalfOfOrgboolean

Example true.

401 Not signed in

Missing, invalid or expired API key.

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 'settings_restricted_users: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 'settings_restricted_users:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Block List entry not found

JSON
{
  "success": false,
  "message": "Block List entry not found.",
  "errors": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Block List entry not found..

errorsstring
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

Server error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected error occurred."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Unexpected error occurred..