API ReferenceSuppression List

Get Users

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

Authentication

x-api-keystring

API key for authentication, sent as the x-api-key header. Used by the Get Users (suppression list) endpoint.

workspace-idstring

The workspace identifier, sent as the workspace-id header. Used alongside x-api-key by the Get Users (suppression list) endpoint.

Path parameters

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

Query parameters

limitintegerOptional1-100Defaults to 10
Number of records to return per page. Defaults to 10 if omitted.
offsetintegerOptional>=0Defaults to 1
Page offset for pagination. Defaults to 1 if omitted.
destinationstringOptional

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.

channelstringOptional

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

distinct_idstringOptional

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

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

channelstring

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

created_atstring

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

destinationstringOptional

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_idstringOptional

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

descriptionstringOptional

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

expiry_tsstringOptional

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

suppression_eventlist of enumsOptional

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

event_typelist of enumsOptional

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

Errors

401
Unauthorized Error