Suppressions

List suppressed email addresses

GET/v1/suppressions

Requires an API key with the suppressions:read scope. About keys and scopes

Admin, or a key with suppressions:read. Every blocked email address in the workspace, newest first, whether or not a contact still exists for it. Sends to these addresses are skipped. Filter by email to check one address exactly (normalised as stored), or by q to match any part of the address.

Query parameters

limitintegeroptional

min > 0 · max 100 · default 20

cursorstringoptional

1–2048 characters

emailstringoptional

One address, matched trimmed and without case: is it blocked?

qstringoptional

Case-insensitive part of the address.

1–320 characters

reasonstringoptional

Only blocks with this reason.

one of manual, imported, unsubscribed, bounced, complained, complained_transactional

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired: uuid
channelstringrequired: one of email
addressstringrequired
reasonstringrequired: Why it is blocked: bounced, complained, complained_transactional, unsubscribed, manual or imported.
removablebooleanrequired: True for manual and imported; bounces, complaints and unsubscribes cannot be removed.
createdAtstringrequired: date-time

curl https://api.kirora.io/v1/suppressions \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/suppressions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/suppressions",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/suppressions", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "channel": "email",
      "address": "address_example",
      "reason": "reason_example",
      "removable": true,
      "createdAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.