Skip to main content

Manage Contacts

Manage your address book programmatically.

List Contacts

Get a paginated list of all contacts.

Endpoint: GET /v1/contacts

Query Parameters

ParamTypeDescription
pagenumberPage number (default: 1).
limitnumberItems per page (max 100, default: 50).
searchstringSearch by name or phone number.

Response

{
"data": [
{
"id": "c1...",
"name": "Alice Smith",
"phoneNumber": "12125551234",
"createdAt": "2023-01-01T00:00:00.000Z"
}
],
"meta": {
"total": 50,
"page": 1,
"limit": 20
}
}

Create Contact

Add a new contact to your address book.

Endpoint: POST /v1/contacts

Request Body

FieldTypeRequiredDescription
namestringYesFull name of the contact.
phoneNumberstringYesPhone number.

Example

{
"name": "Bob Jones",
"phoneNumber": "14155550000"
}