API Reference
Contacts
Create, list, update, delete, import, and export contacts.
POST /api/v1/contacts
Create a contact.
Request
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | Yes | First name |
lastName | string | No | Last name |
phoneNumbers | string[] | No | Phone numbers in E.164 format |
emailAddresses | string[] | No | Email addresses |
appleId | string | No | Apple ID if different from email |
organization | string | No | Company name |
jobTitle | string | No | Job title |
tags | string[] | No | Tags for filtering and grouping |
notes | string | No | Free-form notes |
Response 201
The created contact object.
GET /api/v1/contacts
List contacts.
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | — | Search by name, phone, email, or tag |
tags | string | — | Comma-separated tag filter |
page | number | 1 | Page number |
limit | number | 20 | Results per page |
GET /api/v1/contacts/:id
Get a single contact.
PUT /api/v1/contacts/:id
Update a contact. Partial updates — only include fields you want to change.
DELETE /api/v1/contacts/:id
Delete a contact.
POST /api/v1/contacts/import
Bulk import contacts from a CSV or JSON file. Send as multipart/form-data.
Response 200
{
"created": 45,
"updated": 3,
"failed": 2,
"errors": [
{ "row": 12, "error": "Invalid phone number format" }
]
}GET /api/v1/contacts/export
Export contacts as CSV or JSON.
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
format | string | json | csv or json |
search | string | — | Same filters as list endpoint |
tags | string | — | Same filters as list endpoint |
POST /api/v1/contact-groups
Create a contact group.
Request
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Group name |
GET /api/v1/contact-groups
List all contact groups.
POST /api/v1/contact-groups/:id/members
Add a contact to a group.
Request
| Field | Type | Required | Description |
|---|---|---|---|
contactId | string | Yes | Contact ID to add |
DELETE /api/v1/contact-groups/:id/members/:contactId
Remove a contact from a group.