List

API Reference

Contacts

Get contacts

client.contacts.list(ContactListParams { cid, limit, offset, 3 more } query?, RequestOptionsoptions?): ContactListResponse { assignedToEmail, companyName, created_at, 6 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 { assignedToEmail, companyName, created_at, 6 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

verified?: boolean

Whether the contact is verified

Get contacts

typescript

• http
• typescript
• python

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
  }
]

Returns Examples

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
  }
]