List

API Reference

Contacts

Get contacts

get/api/v2/contacts

Retrieve a list of contacts for the authenticated account

Query ParametersExpand Collapse

cid: optional string

Filter by contact ID

limit: optional number

Maximum number of contacts to return

offset: optional number

Number of contacts to skip

order_by: optional string

Field to sort by

order_direction: optional "asc" or "desc"

Sort direction

Accepts one of the following:

"asc"

"desc"

phone_number: optional string

Filter by phone number

ReturnsExpand Collapse

assignedToEmail: optional string

Email of assigned user

companyName: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time

firstName: optional string

First name

lastName: optional string

Last name

phone: optional string

Phone number in E.164 format

sendblueNumber: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

Get contacts

http

• http
• typescript
• python

curl https://api.sendblue.co/api/v2/contacts \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"

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