Skip to main content
GET
/
contacts
cURL
curl --request GET \
  --url https://letterby.com/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,
        "data": {},
        "address": "<string>",
        "isGDPR": true,
        "name": "<string>",
        "instagram": "<string>",
        "twitter": "<string>",
        "website": "<string>",
        "company": "<string>",
        "country": "<string>",
        "city": "<string>",
        "list": {
          "id": "<string>",
          "name": "<string>",
          "url": "<string>",
          "mode": "<string>",
          "referrals": true,
          "color": "<string>",
          "title": "<string>",
          "desc": "<string>"
        },
        "audiences": "<array>",
        "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<int32>

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

​
page
integer<int32>

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
​
email
string

Filter contacts by email (partial match, case-insensitive)

​
firstName
string

Filter contacts by first name (partial match, case-insensitive)

​
lastName
string

Filter contacts by last name (partial match, case-insensitive)

​
phoneNumber
string

Filter contacts by phone number (partial match, case-insensitive)

​
name
string

Filter contacts by full name (partial match, case-insensitive)

​
company
string

Filter contacts by company (partial match, case-insensitive)

​
country
string

Filter contacts by country (partial match, case-insensitive)

​
city
string

Filter contacts by city (partial match, case-insensitive)

​
instagram
string

Filter contacts by Instagram handle (partial match, case-insensitive)

​
twitter
string

Filter contacts by Twitter handle (partial match, case-insensitive)

​
website
string

Filter contacts by website URL (partial match, case-insensitive)

​
isVerified
boolean

Filter contacts by verification status

​
unsubscribed
boolean

Filter contacts by subscription status

​
isGDPR
boolean

Filter contacts by GDPR consent status

Response

Contacts response

​
data
object