List suppression entries (addresses masked)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

Query Parameters

reason

string

Allowed values: bounce complaint unsubscribe manual imported inbound_unsubscribe

limit

integer

default: 50 >= 1 <= 200

Responses

200

Suppressions (emailMasked).

application/json

object

suppressions

Array<object>

object

string

projectId

string

emailMasked

string

reason

string

Allowed values: bounce complaint unsubscribe manual imported inbound_unsubscribe

scope

string

Allowed values: project global

source

string | null

createdAt

string format: date-time

expiresAt

string | null format: date-time

401

Not authenticated (no valid session/principal).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Authenticated but lacks the required project role.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

GET

/api/projects/{projectId}/email/suppressions

1
curl --request GET \
2
  --url 'https://retidal.com/api/projects/%3Cstring%3E/email/suppressions?limit=50' \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/suppressions?limit=50';
2
const options = {method: 'GET', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/email/suppressions"
4

5
querystring = {"limit":"50"}
6

7
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
8

9
response = requests.get(url, headers=headers, params=querystring)
10

11
print(response.json())

1
import httpx
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/email/suppressions"
4

5
params = [("limit", "50")]
6

7
cookies = {"trackly_session": "<YOUR_API_KEY>"}
8

9
response = httpx.get(url, params=params, cookies=cookies)
10

11
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "net/http"
6
  "io"
7
)
8

9
func main() {
10

11
  url := "https://retidal.com/api/projects/%3Cstring%3E/email/suppressions?limit=50"
12

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

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

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

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

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200Suppressions (emailMasked).

1
{
2
  "suppressions": [
3
    {
4
      "reason": "bounce",
5
      "scope": "project"
6
    }
7
  ]
8
}

List suppression entries (addresses masked)

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

401

Examplegenerated

403

Examplegenerated

Example^generated

Example^generated