> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fyno.io/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fyno.io/docs/_mcp/server.

# Get Users

GET https://api.fyno.io/v1/{WSID}/suppressions

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


Reference: https://fyno.io/docs/api-reference/suppression-list/get-users

## Authentication

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

## Request

### Path parameters

- `WSID` (string, required) — Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

### Query parameters

- `limit` (integer, optional, default: 10) — Number of records to return per page. Defaults to 10 if omitted.
- `offset` (integer, optional, default: 1) — Page offset for pagination. Defaults to 1 if omitted.
- `destination` (string, optional) — 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.
- `channel` (string, optional) — Filter results by communication channel, for example `sms`, `email`, `whatsapp`, or `push`. Use `all` to return suppressions that apply across every channel.
- `distinct_id` (string, optional) — Filter results by the distinct ID you use to identify the user, for example `XXXXXXXX`.

## Response

### 200

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.

- `list of fetch_suppression_list`

## Errors

### 401 Unauthorized Error

API Key or Workspace ID is invalid. User is unauthorised.

- `_message` (string, required)
- `status` (string, required)

## Types

### fetch_suppression_list

- `_id` (string, required) — Unique identifier of the suppression record, for example `6aa1031ffcf7e7a914c121df`.
- `channel` (string, required) — The channel the suppression applies to, for example `sms`, `email`, `whatsapp`, or `push`.
- `created_at` (string, required) — Timestamp when the suppression was created, for example `2026-09-09T12:40:20.997+05:30`.
- `destination` (string, optional) — 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_id` (string, optional) — The distinct ID of the suppressed user, for example `XXXXXXXX`. Present when the record was created using `distinct_id` instead of `destination`.
- `description` (string, optional) — Reason or tag for the suppression, for example `DND` or `user complained about spam`.
- `expiry_ts` (string, optional) — Timestamp at which the suppression expires, for example `2026-09-16T12:40:20.997+05:30`. Omitted when the suppression does not expire.
- `suppression_event` (list of enum, optional) — The event types this suppression applies to, for example `["otp", "transactional", "marketing"]`.
  - Allowed values: `marketing`, `transactional`, `otp`
- `event_type` (list of enum, optional) — The event types the suppression was created with, for example `["marketing", "transactional", "otp"]`. Omitted on records where event types were not specified.
  - Allowed values: `marketing`, `transactional`, `otp`

## Examples

**Response**

```json
[
  {
    "_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"
    ]
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.fyno.io/v1/FYXXXXXXXX/suppressions"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.fyno.io/v1/FYXXXXXXXX/suppressions';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fyno.io/v1/FYXXXXXXXX/suppressions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fyno.io/v1/FYXXXXXXXX/suppressions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fyno.io/v1/FYXXXXXXXX/suppressions")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fyno.io/v1/FYXXXXXXXX/suppressions', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.fyno.io/v1/FYXXXXXXXX/suppressions");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fyno.io/v1/FYXXXXXXXX/suppressions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```