Skip to content
Docs

List Block ListBeta

List blocked emails and domains, newest first.

GET/api/v1/block-list

Requires an API key with the read scope.

Query Parameters#

pageintegerquerydefault 1
Page number.
pageSizeintegerquerydefault 50
Items per page (1-100).
searchstringquery
Substring of the email or domain.
kindstringquery
email or domain.

Response#

dataarray
Show entry
idstring
Entry identifier.
kindstring
email or domain.
valuestring
Lowercased address or domain.
sourcestring
manual, import, unsubscribe or api.
notestring
Optional note, or null.
createdBystring
User id that added it, or null for unsubscribes.
createdAtstring
ISO 8601 timestamp.
metaobject
page, pageSize, total and totalPages.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read
422kind is not email or domain, or pageSize is out of range

Rate Limit#

  • 300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026