Contacts API

Contacts API

The Contacts API lets you create, read, update, and delete contacts in your wrrk CRM programmatically.

List Contacts

GET /v1/contacts

Query Parameters:

• page (int), Page number (default: 1)
• per_page (int), Results per page (default: 25, max: 100)
• search (string), Search by name, email, or phone
• tag (string), Filter by tag
• created_after (datetime), Filter by creation date
• sort (string), Sort field: name, created_at, updated_at

Example Request:

curl -X GET "https://api.wrrk.ai/v1/contacts?page=1&per_page=10&tag=VIP" \
  -H "Authorization: Bearer your-token"

Get Contact

GET /v1/contacts/:id

Returns a single contact with all fields, including custom fields, tags, and associated deals.

Create Contact

POST /v1/contacts

Body:

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "company": "Acme Corp",
  "tags": ["lead", "enterprise"],
  "custom_fields": {
    "industry": "Technology",
    "source": "Website"
  }
}

Required fields: At least one of name, email, or phone.

Update Contact

PUT /v1/contacts/:id

Send only the fields you want to update. Unspecified fields remain unchanged.

Delete Contact

DELETE /v1/contacts/:id

Soft-deletes the contact. It can be restored within 30 days via the UI or API.

Contact Object

{
  "id": "cnt_abc123",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "company": "Acme Corp",
  "tags": ["lead", "enterprise"],
  "custom_fields": { "industry": "Technology" },
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-15T14:30:00Z",
  "last_activity_at": "2026-03-14T09:15:00Z",
  "owner_id": "usr_def456"
}

Pagination

Use the meta object in the response to implement pagination:

"meta": { "page": 1, "per_page": 25, "total": 342 }

Calculate total pages: Math.ceil(total / per_page).