List tenant blocked values
Learn how to retrieve tenant-level blocked values excluded from Autopilot processing, with pagination support and metadata details.
The List tenant blocked values API returns blocked values configured at the tenant level that apply across all lookup types. These values apply across all lookup types and are excluded from Autopilot processing.
The response returns a paginated list of blocked values along with metadata such as creation time and author.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
GET /configuration/{tenantId}/autopilot/blockedValues?offset={offset}&limit={limit}This endpoint retrieves blocked values configured for the specified tenant, with optional pagination support.
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Tenant identifier |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {token} | Yes |
Query parameters
The following table describes the query parameters.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
offset | Integer | No | Starting offset for pagination. | 0 |
limit | Integer | No | Maximum number of results to return. | 100 |
Request body
This operation does not require a request body.
Response body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
tenantId | String | The identifier of the tenant. |
value | String | The blocked value. |
createdAt | Number | The timestamp when the blocked value was created, in epoch milliseconds. |
createdBy | String | The identifier of the user who created the blocked value. |
Example response
The following example shows a response containing tenant-level blocked values.
[
{
"tenantId": "my_tenant",
"value": "NA",
"createdAt": 1704153600000,
"createdBy": "admin@company.com"
},
{
"tenantId": "my_tenant",
"value": "UNKNOWN",
"createdAt": 1704153700000,
"createdBy": "admin@company.com"
}
]