Skip to main content
GET
/
v1
/
suppressions
List suppressed email addresses
curl --request GET \
  --url https://api.mail.gorillaa.one/v1/suppressions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "reason": "hard_bounce",
      "source": "<string>",
      "suppressedAt": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your Gorillaa Mail API key as a Bearer token.

Example: Authorization: Bearer grl_live_xxxxxxxxxxxx

Keys prefixed grl_test_ operate in test mode with reduced limits.

Query Parameters

​
reason
enum<string>

Filter by suppression reason. Note that soft_bounce is not a valid filter value.

Available options:
hard_bounce,
spam_complaint,
unsubscribe,
manual,
blocklist
​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

List of suppression entries

​
data
object[]
required
​
pagination
object
required