Ventia
Contact
GET
/contacts
api-key<token>

In: query

Query Parameters

page?integer

Page number to return (1-indexed). Defaults to 1.

Default1
Range1 <= value
limit?integer

Number of contacts to return per page. Defaults to 10.

Default10
Range1 <= value
search?string

Case-insensitive substring to match against the contact field specified by field. Must be used together with field.

field?string

Contact field to apply search against. Supports top-level fields (e.g. firstName, lastName, emails, phones) and custom fields via additionalData.<code>. The company field is not allowed.

campaignId?string

Filter contacts associated with the given Ventia campaign id. Must be a valid ObjectId; matches contacts whose campaigns array contains this id.

Match^[a-fA-F0-9]{24}$
agent?string

Filter contacts assigned to the specified agent. Must be a valid ObjectId; returns only contacts associated with this agent.

Match^[a-fA-F0-9]{24}$
firstAgent?string

Filter contacts that were initially assigned to the specified seller. Must be a valid ObjectId; returns only contacts whose first assigned seller matches this id.

Match^[a-fA-F0-9]{24}$
sort?string

Sort the results by one of the allowed fields. Prefix with + for ascending or - for descending (default is ascending). Allowed fields: createdAt, lastInteraction, lastInteractionDate.

Value in"+createdAt" | "-createdAt" | "+lastInteraction" | "-lastInteraction" | "+lastInteractionDate" | "-lastInteractionDate"
gteCreatedAt?string

Return contacts created on or after this date (ISO 8601). Date filters can be combined with their lte/lt/gt counterparts to build a range.

Formatdate-time
lteCreatedAt?string

Return contacts created on or before this date (ISO 8601).

Formatdate-time
gtCreatedAt?string

Return contacts created strictly after this date (ISO 8601).

Formatdate-time
ltCreatedAt?string

Return contacts created strictly before this date (ISO 8601).

Formatdate-time
gteLastInteractionDate?string

Return contacts whose last interaction is on or after this date (ISO 8601).

Formatdate-time
lteLastInteractionDate?string

Return contacts whose last interaction is on or before this date (ISO 8601).

Formatdate-time
gtLastInteractionDate?string

Return contacts whose last interaction is strictly after this date (ISO 8601).

Formatdate-time
ltLastInteractionDate?string

Return contacts whose last interaction is strictly before this date (ISO 8601).

Formatdate-time

Response Body

application/json; charset=utf-8

curl -X GET "https://api.getventia.com/api/v1.0/contacts?page=1&limit=25&search=agustin&field=firstName&campaignId=62a1c1ff61ffd5f1e446d234&agent=62a1c1ff61ffd5f1e426d231&firstAgent=62a1c1ff61ffd5f1e426d231&sort=-lastInteractionDate&gteCreatedAt=2026-01-01T00%3A00%3A00.000Z&lteCreatedAt=2026-01-31T23%3A59%3A59.999Z"
[
  {
    "_id": "621e8a5463c02a8bd532ff8c",
    "company": "609b3cff61ffd5f1e446d234",
    "firstName": "Agustin",
    "lastName": "Suarez",
    "origin": "local",
    "phones": [
      "+59897123678"
    ],
    "agent": "6234da84259c59d9a555c498",
    "firstAgent": "6234da84259c59d9a555c498",
    "agentAssigned": "2022-03-01T21:04:20.611Z",
    "archivingReason": "",
    "status": "closed",
    "emails": [],
    "detail": "",
    "createdAt": "2022-03-01T21:04:20.617Z",
    "updatedAt": "2022-05-20T16:00:00.004Z",
    "__v": 0,
    "lastInteraction": "2022-05-20T16:00:00.004Z",
    "archivingReasonText": "",
    "agentFullName": "Agente Uno"
  }
]