List

API Reference

Contacts

Get contacts

client.contacts.list(?, ?):

get/api/v2/contacts

Retrieve a list of contacts for the authenticated account

Parameters

query

Hide ParametersShow Parameters

cidstring

optional

Filter by contact ID

limitnumber

optional

Maximum number of contacts to return

offsetnumber

optional

Number of contacts to skip

order_bystring

optional

Field to sort by

order_directionunion

optional

"asc" | "desc"

Sort direction

Hide ParametersShow Parameters

"asc"

"desc"

phone_numberstring

optional

Filter by phone number

Returns

ContactListResponsealias

Array<>

Hide ParametersShow Parameters

assignedToEmailstring

optional

Email of assigned user

companyNamestring

optional

Company name

created_atstring

optional

When the contact was created

formatdate-time

firstNamestring

optional

First name

lastNamestring

optional

Last name

phonestring

optional

Phone number in E.164 format

sendblueNumberstring

optional

Associated Sendblue phone number

tagsarray

optional

Array<string>

Tags associated with the contact

verifiedboolean

optional

Whether the contact is verified

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const contacts = await client.contacts.list();

console.log(contacts);

200 Example

[
  {
    "assignedToEmail": "[email protected]",
    "companyName": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1234567890",
    "sendblueNumber": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  }
]