Get contacts

client.contacts.list(?, ?): ContactListResponse { assigned_to_email, company_name, created_at, 7 more }

GET/api/v2/contacts

Retrieve a list of contacts for the authenticated account

ParametersExpand Collapse

query: ContactListParams { cid, limit, offset, 3 more }

cid?: string

Filter by contact ID

limit?: number

Maximum number of contacts to return

offset?: number

Number of contacts to skip

order_by?: string

Field to sort by

order_direction?: "asc" | "desc"

Sort direction

Accepts one of the following:

"asc"

"desc"

phone_number?: string

Filter by phone number

ReturnsExpand Collapse

ContactListResponse = Array<Contact { assigned_to_email, company_name, created_at, 7 more } >

assigned_to_email?: string

Email of assigned user

company_name?: string

Company name

created_at?: string

When the contact was created

formatdate-time

custom_variables?: Record<string, string>

Custom key-value pairs stored on the contact. Keys are human-readable labels.

first_name?: string

First name

last_name?: string

Last name

phone?: string

Phone number in E.164 format

sendblue_number?: string

Associated Sendblue phone number

tags?: Array<string>

Tags associated with the contact

verified?: boolean

Whether the contact is verified

Get contacts

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 contacts = await client.contacts.list();

console.log(contacts);

[
  {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  }
]

Returns Examples

[
  {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  }
]