Workestra
API ReferenceEndpoints

Contacts API

Create, read, update, and delete CRM contacts.

List Contacts

GET /api-contacts

Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
per_pageintegerItems per page (default: 25, max: 100)
emailstringFilter by email address
companystringFilter by company name
sortstringSort field (default: created_at)
orderstringSort order: asc or desc

Response

{
  "data": [
    {
      "id": "uuid",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john@example.com",
      "phone": "+1234567890",
      "company": "Acme Corp",
      "tags": ["customer", "enterprise"],
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-20T14:00:00Z"
    }
  ],
  "count": 1
}

Get Contact

GET /api-contacts?id=<contact_id>

Returns a single contact by ID.


Create Contact

POST /api-contacts

Body

{
  "first_name": "John",
  "last_name": "Smith",
  "email": "john@example.com",
  "phone": "+1234567890",
  "company": "Acme Corp",
  "tags": ["customer"]
}

Required Fields

  • first_name or last_name (at least one)
  • email

Update Contact

PATCH /api-contacts?id=<contact_id>

Body

Send only the fields you want to update:

{
  "phone": "+0987654321",
  "tags": ["customer", "vip"]
}

Delete Contact

DELETE /api-contacts?id=<contact_id>

Returns 204 No Content on success.