API REFERENCE

Records

Manage your contact data. Records are the individual entities (Leads, Patients, etc.) that your campaigns interact with. Each record is associated with a specific Record Type which defines its custom fields.

List all records

GEThttp://localhost:3000/api/records

Returns a paginated list of records. You can filter by recordTypeUuid or campaignUuid, and search across custom fields.

Query Parameters

Parameter	Type	Description
recordTypeUuid	string	Filter by record type.
campaignUuid	string	Filter by assigned campaign.
search	string	Search across record parameters.
page	number	Page number for pagination.
limit	number	Items per page (max 100).

Responses

JSON

{
  "records": [
    {
      "uuid": "record_12345",
      "recordTypeUuid": "7d4f10a2-b91c-4d5e-6f7a-8b9c0d1e2f3a",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1234567890",
      "parameters": {
        "amount": 50,
        "last_visit": "2026-04-01"
      },
      "status": "active",
      "createdAt": "2026-04-10T09:24:11Z",
      "updatedAt": "2026-04-22T13:58:02Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

Create a new record

POSThttp://localhost:3000/api/records

Creates a new record. You must specify the recordTypeUuid and provide the data for any required custom fields within the parameters object.

Body Parameters

Field	Type	Description
recordTypeUuid *	string	UUID of the record type defining the schema.
firstName	string	Record first name (if applicable).
lastName	string	Record last name (if applicable).
phone *	string	Primary phone number for calls.
parameters	object	Key-value pairs for custom fields defined in the record type.

Responses

JSON

{
  "uuid": "record_12345",
  "recordTypeUuid": "7d4f10a2-b91c-4d5e-6f7a-8b9c0d1e2f3a",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1234567890",
  "parameters": {
    "amount": 50,
    "last_visit": "2026-04-01"
  },
  "status": "active",
  "createdAt": "2026-04-10T09:24:11Z",
  "updatedAt": "2026-04-22T13:58:02Z"
}

Get a record

GEThttp://localhost:3000/api/records/{uuid}

Retrieves the full details of a specific record, including all its custom field values and associated campaign history.

Responses

JSON

{
  "uuid": "record_12345",
  "recordTypeUuid": "7d4f10a2-b91c-4d5e-6f7a-8b9c0d1e2f3a",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1234567890",
  "parameters": {
    "amount": 50,
    "last_visit": "2026-04-01"
  },
  "status": "active",
  "createdAt": "2026-04-10T09:24:11Z",
  "updatedAt": "2026-04-22T13:58:02Z"
}

Update a record

PATCHhttp://localhost:3000/api/records/{uuid}

Updates an existing record. You can update the core fields or individual values within the parameters object.

Body Parameters

Field	Type	Description
firstName	string	Update first name.
lastName	string	Update last name.
phone	string	Update phone number.
parameters	object	Update specific custom field values.

Responses

JSON

{
  "uuid": "record_12345",
  "recordTypeUuid": "7d4f10a2-b91c-4d5e-6f7a-8b9c0d1e2f3a",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1234567890",
  "parameters": {
    "amount": 50,
    "last_visit": "2026-04-01"
  },
  "status": "active",
  "createdAt": "2026-04-10T09:24:11Z",
  "updatedAt": "2026-04-22T13:58:02Z"
}

Delete a record

DELETEhttp://localhost:3000/api/records/{uuid}

Permanently removes a record from your account. This action will also remove it from any assigned campaigns.

Responses

// 204 No Content