GET
/
contacts
curl --request GET \
  --url https://wt.ls/api/v4/contacts \
  --header 'apiKey: <api-key>'
{
  "data": {
    "contacts": [
      {
        "id": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "points": 123,
        "referrals": 123,
        "listId": "<string>",
        "isVerified": true,
        "unsubscribed": true,
        "customData": {},
        "address": "<string>",
        "isGDPR": true,
        "name": "<string>",
        "instagram": "<string>",
        "twitter": "<string>",
        "website": "<string>",
        "company": "<string>",
        "country": "<string>",
        "city": "<string>",
        "list": {},
        "audiences": [
          "<any>"
        ],
        "referralLink": "<string>",
        "privateLink": "<string>"
      }
    ],
    "pagination": {
      "total": 123,
      "pages": 123,
      "currentPage": 123,
      "perPage": 123
    }
  }
}

Authorizations

​
apiKey
string
header
required

API key to authorize requests

Query Parameters

​
listId
string
required

Filter contacts by list ID

​
limit
integer

The maximum number of results to return (default and max: 20000)

​
page
integer

Page number for pagination

​
sort
enum<string>

Field to sort by (default sorts by points and createdAt)

Available options:
points,
createdAt,
email,
firstName,
lastName,
position
​
order
enum<string>

Sort order (default: desc)

Available options:
asc,
desc

Response

200
application/json
Contacts response
​
data
object
Delete ContactCreate Action