Skip to content
Reference/Contacts/List Contacts

List Contacts

GEThttps://public.leadpattern.com/customer/list
application/json60 req/min

Retrieve a paginated list of contacts, with optional search and smart filters.

  • limit defaults to 10 and is capped at 100.
  • Unknown query parameters are rejected with 400.
  • filters is a JSON string of smart-filter rules; filterLogic is AND or OR.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Query Parameters

3 fields
pagenumber
optionaldefault: 1
Page number.
limitnumber
optionaldefault: 20
Results per page.
searchstring
optional
Search by name/phone.

Responses

Note: this endpoint returns the paginate result directly, without the usual type:"success" wrapper.
JSON Response
{
  "data": {
    "results": [
      {
        "id": "664abc...",
        "waId": "9195XXXXXXXX",
        "name": {
          "first": "John"
        }
      }
    ],
    "totalResults": 1,
    "page": 1,
    "totalPages": 1
  }
}

Sample Request

{
  "page": 1,
  "limit": 20,
  "search": "john"
}