FYfynoio
Suppression List

Get Users

Changed on

Retrieves a paginated list of suppressed users from the Fyno suppression list for the specified workspace.

get/{WSID}/suppressions

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/suppressions
  • Auth
    API key in header x-api-key and API key in header workspace-id

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

Query parameters

limitinteger

Number of records to return per page. Defaults to 10 if omitted.

offsetinteger

Page offset for pagination. Defaults to 1 if omitted.

destinationstring

Filter results by destination address, for example abcde@fghi.com, +49XXXXXXXXX, or ExponentPushToken[XXXXX]. Enter an email address for email suppressions, a phone number with the country code for SMS and WhatsApp suppressions, or a token for push suppressions.

channelstring

Filter results by communication channel, for example sms, email, whatsapp, or push. Use all to return suppressions that apply across every channel.

distinct_idstring

Filter results by the distinct ID you use to identify the user, for example XXXXXXXX.

Response

Returns an array of suppression records. Each record identifies the suppressed user by either destination (an email address, phone number, or push token) or distinct_id, along with the channel it applies to and the event types the suppression covers.

_idstring required

Unique identifier of the suppression record, for example 6aa1031ffcf7e7a914c121df.

destinationstring

The suppressed email address, phone number, or push token, for example abcde@fghi.com, +49XXXXXXXXX, or ExponentPushToken[XXXXX]. Present when the record was created using destination instead of distinct_id.

distinct_idstring

The distinct ID of the suppressed user, for example XXXXXXXX. Present when the record was created using distinct_id instead of destination.

channelstring required

The channel the suppression applies to, for example sms, email, whatsapp, or push.

descriptionstring

Reason or tag for the suppression, for example DND or user complained about spam.

created_atstring required

Timestamp when the suppression was created, for example 2026-09-09T12:40:20.997+05:30.

expiry_tsstring

Timestamp at which the suppression expires, for example 2026-09-16T12:40:20.997+05:30. Omitted when the suppression does not expire.

suppression_eventstring[]

The event types this suppression applies to, for example ["otp", "transactional", "marketing"].

event_typestring[]

The event types the suppression was created with, for example ["marketing", "transactional", "otp"]. Omitted on records where event types were not specified.

Example response

[
  {
    "_id": "6aa1031ffcf7e7a914c121df",
    "channel": "sms",
    "created_at": "2026-09-09T12:40:20.997+05:30",
    "distinct_id": "XXXXXXXX",
    "description": "DND",
    "suppression_event": [
      "marketing",
      "transactional",
      "otp"
    ],
    "event_type": [
      "marketing",
      "transactional",
      "otp"
    ]
  },
  {
    "_id": "6aa0fb0afcf7e7a914c121de",
    "channel": "sms",
    "created_at": "2026-09-09T12:26:26.820+05:30",
    "distinct_id": "XXXXXXXX",
    "description": "DND",
    "suppression_event": [
      "marketing",
      "transactional",
      "otp"
    ],
    "event_type": [
      "marketing",
      "transactional",
      "otp"
    ]
  },
  {
    "_id": "68c109050ecf764967285e4e",
    "channel": "email",
    "created_at": "2026-05-22T07:52:54.232+05:30",
    "destination": "abcde@fghi.com",
    "description": "Dnd",
    "suppression_event": [
      "otp",
      "transactional",
      "marketing"
    ]
  },
  {
    "_id": "68b8151d0ecf764967285e4d",
    "channel": "sms",
    "created_at": "2025-09-03T15:44:53.254+05:30",
    "destination": "+49XXXXXXXXX",
    "description": "DND",
    "suppression_event": [
      "otp",
      "transactional",
      "marketing"
    ]
  },
  {
    "_id": "689b03fca4e73c04bd9f54e9",
    "channel": "push",
    "created_at": "2025-08-12T16:06:45.749+05:30",
    "destination": "ExponentPushToken[XXXXX]",
    "description": "DND",
    "suppression_event": [
      "otp",
      "transactional",
      "marketing"
    ]
  },
  {
    "_id": "689b0449a4e73c04bd9f54ee",
    "channel": "push",
    "created_at": "2025-08-12T14:37:21.351+05:30",
    "distinct_id": "XXXXXXXX",
    "description": "user complained about spam",
    "suppression_event": [
      "otp",
      "transactional",
      "marketing"
    ]
  }
]

Changes

  • 63b60a94cdbbRevision changes
    • info

      the endpoint scheme security ApiKeyAuth AND WorkspaceIdAuth was added to the API

    • info

      the query request parameter limit became optional

    • info

      the query request parameter offset became optional

  • f620f85db863Revision changes
    • warning

      added the new marketing enum value to the // response property for the response status

    • warning

      added the new otp enum value to the // response property for the response status

    • warning

      added the new transactional enum value to the // response property for the response status

    • info

      the endpoint scheme security ApiKeyAuth AND WorkspaceIdAuth was removed from the API

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status