v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Retrieve a list of contacts

get/v2/contacts

Query parameters

limitstring

Return up to this many results per page. (≤ 50 default 15)

pagestring

Return the data of the specified page

searchstring

Filters contacts by matching the search term against firstname, lastname, company_name, country, or email. Supports partial matches.

tagsstring

A comma-separated list of numeric Tag IDs (e.g., 12,45,89). Only contacts associated with these specific labels will be returned.

typestring

Filters the results by the contact_type field. Must be an exact string match (e.g., lead, customer, partner)..

Response

200

Example response

{
  "data": [
    {
      "id": 6897,
      "contact_type": "customer",
      "first_name": "Sam",
      "last_name": "Winchester",
      "email": "sam@example.com",
      "address1": "504 Main St",
      "country": "US",
      "city": "Westbury",
      "state": "NY",
      "zip_code": "11590",
      "created_at": "2026-01-06T14:34:29-05:00",
      "labels": [
        {
          "id": 1,
          "name": "Wealthbox"
        }
      ]
    }
  ],
  "pagination": {
    "path": "http://localhost:8000/v2/contacts",
    "total": 39,
    "limit": 2,
    "current_page": 1,
    "last_page": 20,
    "has_more": true
  }
}