List workspace-platform-level suppressions

List workspace-platform-level suppressions

get

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/suppressions

Retrieve a list of all workspace-platform-level suppressions

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list.

Example: nextPageToken123

reversebooleanOptional

Order in which to retrieve the results.

Default: false

platformTypestring · enumOptional

The type of the platform.

Possible values:

withMarketingSuppressedbooleanOptional

Include contacts that are suppressed for marketing.

withTransactionsSuppressedbooleanOptional

Include contacts that are suppressed for transactional.

Responses

200

OK

application/json

404

Workspace not found

application/json

get

/workspaces/{workspaceId}/suppressions

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/suppressions HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "platformId": "apple-business-chat",
      "platformType": "sms",
      "identifierValue": "text",
      "suppressedForOriginators": [
        {
          "channelIdentifier": "text"
        }
      ],
      "suppressedFor": {
        "marketing": true,
        "transactional": true
      },
      "reasons": {
        "marketing": "unknown",
        "transactional": "unknown"
      },
      "contactSuppressedMarketingAt": "2026-03-13T16:24:43.469Z",
      "contactSuppressedMarketingReason": "text",
      "contactSuppressedTransactionalAt": "2026-03-13T16:24:43.469Z",
      "contactSuppressedTransactionalReason": "text",
      "marketerSuppressedMarketingAt": "2026-03-13T16:24:43.469Z",
      "marketerSuppressedMarketingReason": "text",
      "marketerSuppressedTransactionalAt": "2026-03-13T16:24:43.469Z",
      "marketerSuppressedTransactionalReason": "text",
      "contact": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "computedDisplayName": "John Doe",
        "createdAt": "2026-03-13T16:24:43.469Z",
        "updatedAt": "2026-03-13T16:24:43.469Z",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
        "featuredIdentifiers": [
          {
            "key": "emailaddress",
            "value": "[email protected]"
          }
        ],
        "attributes": {
          "firstName": "John",
          "lastName": "Smith",
          "rating": 9.6,
          "cookiesAccepted": false,
          "labels": [
            "A",
            "B",
            "C"
          ]
        },
        "identifierCount": 2,
        "accountIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "listIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "companyRefs": [
          "text"
        ],
        "isAnonymous": true
      }
    }
  ],
  "nextPageToken": "text"
}