Skip to main content
GET
/
contacts
cURL
curl --request GET \
  --url https://api.konvoai.com/contacts \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "result": [
    {
      "firstName": "Jefferey",
      "lastName": "Bezos",
      "preferredName": "Jeff",
      "email": "jeff@amazon.com",
      "phoneNumber": "15552345678",
      "lastInteractionDate": "2024-08-02T14:58:55.728Z",
      "tags": [
        {
          "id": "01823bbc-96e0-4c0a-a9cd-0a41ede22d50",
          "label": "Giveaway #3",
          "description": "",
          "color": "#FFE3EA",
          "category": "MARKETING"
        }
      ],
      "optInStatus": "granted",
      "active": "true",
      "createdAt": "2024-08-02T14:58:55.728Z",
      "source": "Klaviyo",
      "properties": [
        "<any>"
      ],
      "language": "en",
      "birthday": "2024-08-02T14:58:55.728Z",
      "orders": [
        {
          "id": "1d2686c1-7342-475a-ba38-e13364807343"
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer

Pointer for the current page of the paginated query

limit
integer

The maximum number of results to return, maximum is 200

fields
string

Comma separated list of fields you want to retrieve from the contact. Omitting this will return all fields. Using this param will speed up requests

updated_at_min
string

Filter by contacts updated after a certain date

updated_at_max
string

Filter by contacts updated before a certain date

q
string

Search parameter. Looks in the fields (email, phone, name, etc) to find contacts in the database

Response

Get contacts response

count
integer

Total count of the request

result
object[]

Resulting query