Skip to content
  • Auto
  • Light
  • Dark
Get Started

Retrieve

Get a contact
contacts.retrieve(strphone_number) -> ContactRetrieveResponse
get/api/v2/contacts/{phone_number}

Retrieve a specific contact by phone number

ParametersExpand Collapse
phone_number: str
ReturnsExpand Collapse
class ContactRetrieveResponse:
contact: Optional[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

status: Optional[str]
Get a contact
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key="My API Key",
    api_secret="My API Secret",
)
contact = client.contacts.retrieve(
    "+1234567890",
)
print(contact.contact)
{
  "contact": {
    "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
  },
  "status": "OK"
}
Returns Examples
{
  "contact": {
    "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
  },
  "status": "OK"
}