API ReferenceSuppression List

Get Users

Retrieves a paginated list of suppressed users from the Fyno suppression list for the specified workspace. You can narrow the results using the optional `destination`, `channel`, and `distinct_id` filters, in addition to the required `limit`/`offset` pagination parameters. Example request: `GET {{API_URL}}/v1/{{WSID}}/suppressions?limit=10&offset=1`

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

limitintegerRequired1-100
Number of records to return per page.
offsetintegerRequired>=0

Page offset for pagination (0-indexed).

destinationstringOptional

(Optional) Filter results by destination address (e.g. email or phone number). Example: world@world.com.

channelstringOptional

(Optional) Filter results by communication channel. For example: sms, email, all.

distinct_idstringOptional

(Optional) Filter results by the unique identifier of the user. Example: world@world.com.

Response

Returns an array of suppression records. Each record identifies the suppressed user by either `destination` (phone/email) or `distinct_id`, along with the `channel` it applies to (or `all` for every channel), and includes `event_type`/`suppression_event` when the suppression is scoped to specific event types rather than all events.
_idstringOptional
Unique identifier of the suppression record
destinationstringOptional

Phone number or email of the suppressed user. Present when the record was created using destination instead of distinct_id.

distinct_idstringOptional

The unique identifier of the suppressed user, if applicable. Present when the record was created using distinct_id instead of destination.

channelstringOptional

Communication channel (e.g., sms, whatsapp, email). Set to all when the suppression applies across every channel.

descriptionstringOptional

Reason or tag for suppression (e.g., “DND”, “Testing”).

created_atstringOptional
Timestamp when the suppression was created
expiry_tsstringOptional
Optional timestamp for expiration of suppression
event_typelist of enumsOptional

(Optional) The event types this suppression is scoped to (marketing, transactional, otp). Omitted when the suppression applies to all event types.

suppression_eventlist of stringsOptional

(Optional) List of specific notification events tied to this suppression record, when applicable.

Errors

401
Unauthorized Error