Get contacts

client.contacts.list(?): ContactListResponse { assignedToEmail, companyName, created_at, 5 more }

get/api/v2/contacts

Retrieve a list of contacts for the authenticated account

ReturnsExpand Collapse

ContactListResponse = Array<Contact { assignedToEmail, companyName, created_at, 5 more } >

assignedToEmail?: string

Email of assigned user

companyName?: string

Company name

created_at?: string

When the contact was created

formatdate-time

firstName?: string

First name

lastName?: string

Last name

phone?: string

Phone number in E.164 format

sendblueNumber?: string

Associated Sendblue phone number

tags?: Array<string>

Tags associated with the contact

Get contacts

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);

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

Returns Examples

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