For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
      • GETGet the list of blocked or unsubscribed transactional contacts
      • DELUnblock or resubscribe a transactional contact
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Email APIBlocked email recipients

Get the list of blocked or unsubscribed transactional contacts

GET
https://api.brevo.com/v3/smtp/blockedContacts
GET
/v3/smtp/blockedContacts
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.transactionalEmails.getTransacBlockedContacts({});
8}
9main();
1{
2  "contacts": [
3    {
4      "blockedAt": "2017-05-01T12:30:00Z",
5      "email": "abc@xyz.com",
6      "reason": {
7        "code": "adminBlocked",
8        "message": "Admin blocked"
9      },
10      "senderEmail": "ez312@gmal.com"
11    }
12  ],
13  "count": 1
14}
Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.
Was this page helpful?
Previous

Unblock or resubscribe a transactional contact

Next
Built with

Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both startDate and endDate must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the sort parameter.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

startDatestringOptional

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts

endDatestringOptional

Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts

limitlongOptional0-100Defaults to 50
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document on the page
senderslist of stringsOptional
Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

List of blocked or unsubscribed transactional contacts
contactslist of objects
countlong
Count of blocked or unsubscribed contact

Errors

400
Bad Request Error