Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Contacts

GET Contact Consent Counts

Use to get the total contacts count for the account and the total contact-consent counts for each consent state. Optionally, to include the total number of contacts that subscribed within the last 30 days in the results, use new_subscribers in the include query parameter. To optimize open rates, reduce spam reports, and help grow your business, you must value your contact's consent to receive or to not receive your emails.

get/contacts/counts

Query parameters

include'new_subscriber'

Use to return the total number of contacts that subscribed within the last 30 days in the results.

Response

Request successful

totalinteger

Total number of contacts for the account.

explicitinteger

Total number of contacts explicitly confirmed. Consent is obtained when you explicitly ask your potential contacts for permission to send the email (for example, using a sign-up form) and they agree. After you obtain express consent, it is good forever or until the contact opts out.

implicitinteger

Total number of contacts implicitly confirmed. Consent is inferred based on actions, such as having an existing business relationship (making a purchase or donation, for example). In order to maintain implied consent to comply with CASL a contact must take a business action with you at least once every two years. Under CAN-Spam there is no need to maintain implied consent, it is assumed until the receiver indicates they no longer wish to receive messages.

pendinginteger

Total number of contacts pending confirmation. Consent is requested and pending confirmation from the contact.

unsubscribedinteger

Total number of unsubscribed contacts. Consent is revoked when a contact has unsubscribed.

new_subscriberinteger

Total number of newly subscribed contacts.

Example response

{
  "total": 72,
  "explicit": 10,
  "implicit": 20,
  "pending": 30,
  "unsubscribed": 12,
  "new_subscriber": 1
}