List

API Reference

Contacts

Get contacts

contacts.list(ContactListParams**kwargs) -> ContactListResponse

get/api/v2/contacts

Retrieve a list of contacts for the authenticated account

ParametersExpand Collapse

cid: Optional[str]

Filter by contact ID

limit: Optional[int]

Maximum number of contacts to return

offset: Optional[int]

Number of contacts to skip

order_by: Optional[str]

Field to sort by

order_direction: Optional[Literal["asc", "desc"]]

Sort direction

Accepts one of the following:

"asc"

"desc"

phone_number: Optional[str]

Filter by phone number

ReturnsExpand Collapse

ContactListResponse = List[Contact]

assigned_to_email: Optional[str]

Email of assigned user

company_name: Optional[str]

Company name

created_at: Optional[datetime]

When the contact was created

formatdate-time

first_name: Optional[str]

First name

last_name: Optional[str]

Last name

phone: Optional[str]

Phone number in E.164 format

sendblue_number: Optional[str]

Associated Sendblue phone number

tags: Optional[List[str]]

Tags associated with the contact

verified: Optional[bool]

Whether the contact is verified

Get contacts

python

• http
• typescript
• python

from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key="My API Key",
    api_secret="My API Secret",
)
contacts = client.contacts.list()
print(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
  }
]