Get contact count

client.contacts.count(?): ContactCountResponse { count }

GET/api/v2/contacts/count

Get the total number of contacts

ReturnsExpand Collapse

ContactCountResponse { count }

count?: number

Total number of contacts

Get contact count

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

const response = await client.contacts.count();

console.log(response.count);

{
  "count": 0
}

Returns Examples

{
  "count": 0
}