Skip to content

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

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 20, max: 100)
searchstringSearch 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

FieldTypeRequiredDescription
firstNamestringNo*First name
lastNamestringNo*Last name
companystringNo*Company name
jobTitlestringNoJob title
phoneNumberstringNo*Phone number in E.164 format
emailstringNo*Email address
streetstringNoStreet address
citystringNoCity
statestringNoState or province
postalCodestringNoPostal/ZIP code
countrystringNoCountry code (e.g., US)
websitestringNoWebsite URL
birthdaystringNoISO 8601 date
notesstringNoFree-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"
}

Replicer API Documentation