List allow/block rules

List Allow/Block rules

GEThttps://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules

Path parameters

workspaceId*string (uuid)

The workspace ID

Query parameters

Response

200

A paginated list of Allow/Block rules.

Body

application/json

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

results*array of Conversations_AllowBlockRule (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "nextPageToken": "text",
  "results": [
    {
      "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": "2024-12-03T08:24:04.299Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-12-03T08:24:04.299Z"
    }
  ]
}

Examples

Request

curl "https://api.bird.com/workspaces/e58899bf-1e8d-4ff7-b9db-a60befaf90d2/conversation-allowblock-rules" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "results": [
    {
      "id": "01937899-aa2c-7224-bf2b-db9ca8f6362c",
      "workspaceId": "6b1908bd-2bc7-409e-bab4-ccfcd3ec69b9",
      "category": "email",
      "value": "[e-mail]",
      "type": "allow",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-11-29T15:45:56.780546536Z",
      "updatedBy": "00000000-0000-0000-0000-000000000000",
      "updatedAt": "2024-11-29T15:45:56.780546536Z"
    },
    {
      "id": "01937888-e7c4-79dd-af1f-c00d91a0f3a6",
      "workspaceId": "6b1908bd-2bc7-409e-bab4-ccfcd3ec69b9",
      "category": "domain",
      "value": "test.com",
      "type": "reject",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-11-29T15:27:38.436082756Z",
      "updatedBy": "00000000-0000-0000-0000-000000000000",
      "updatedAt": "2024-11-29T15:27:38.436082756Z"
    }
  ]
}

Note: if there are more than 10 allow/block rules, the results may be paginated. Please refer to Pagination on how to use nextPageToken.