Get allow/block rule

Get Allow/Block rule

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

allowBlockRuleIdstring · uuidRequired

Responses

200

The Allow/Block rule.

application/json

An AllowBlockRule is a rule that allows or blocks a specific value in a specific category.

idstring · uuidRequired

workspaceIdstring · uuidRequired

categorystring · enumRequired

The category of the AllowBlockRule.

Possible values:

valuestringRequired

typestring · enumRequired

The type of the AllowBlockRule.

Possible values:

createdBystring · uuidRequired

createdAtstring · date-timeRequired

updatedBystring · uuidRequired

updatedAtstring · date-timeRequired

404

The resource specified in the URL was not found

application/json

get

/workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "all",
  "value": "text",
  "type": "allow",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-03-17T08:50:32.365Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-03-17T08:50:32.365Z"
}