Contacts
Create and manage your organization's contact database.
List contacts
GET /v1/contacts
Retrieve a paginated list of contacts.
Required scope: contacts:read
Query parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Results per page (default: 20, max: 100) |
search | string | Search by name, email, phone number, or company |
Example
bash
curl "https://api.replicer.ai/v1/contacts?search=john&limit=10" \
-H "Authorization: Bearer rpl_live_your_key"Response 200 OK
json
{
"data": [
{
"id": "clx-contact-001",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Corp",
"jobTitle": "CTO",
"phoneNumber": "+1234567890",
"email": "[email protected]",
"street": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"country": "US",
"website": "https://acme.com",
"birthday": "1990-03-15T00:00:00Z",
"notes": "Met at conference",
"createdAt": "2026-03-01T10:00:00Z",
"updatedAt": "2026-04-01T15:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 45,
"totalPages": 5
},
"requestId": "req-abc123"
}Create a contact
POST /v1/contacts
Create a new contact in your organization.
Required scope: contacts:write
Request body
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | No* | First name |
lastName | string | No* | Last name |
company | string | No* | Company name |
jobTitle | string | No | Job title |
phoneNumber | string | No* | Phone number in E.164 format |
email | string | No* | Email address |
street | string | No | Street address |
city | string | No | City |
state | string | No | State or province |
postalCode | string | No | Postal/ZIP code |
country | string | No | Country code (e.g., US) |
website | string | No | Website URL |
birthday | string | No | ISO 8601 date |
notes | string | No | Free-text notes |
INFO
*At least one of firstName, lastName, company, phoneNumber, or email is required.
Example
bash
curl -X POST https://api.replicer.ai/v1/contacts \
-H "Authorization: Bearer rpl_live_your_key" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Jane",
"lastName": "Smith",
"phoneNumber": "+1555123456",
"email": "[email protected]",
"company": "Smith Industries"
}'Response 201 Created
json
{
"data": {
"id": "clx-contact-002",
"firstName": "Jane",
"lastName": "Smith",
"company": "Smith Industries",
"jobTitle": null,
"phoneNumber": "+1555123456",
"email": "[email protected]",
"street": null,
"city": null,
"state": null,
"postalCode": null,
"country": null,
"website": null,
"birthday": null,
"notes": null,
"createdAt": "2026-04-05T10:00:00Z",
"updatedAt": "2026-04-05T10:00:00Z"
},
"requestId": "req-def456"
}
