Skip to main content
GET
/
audience
/
contacts
List audience contacts
curl --request GET \
  --url https://app.lettr.com/api/audience/contacts \
  --header 'Authorization: Bearer <token>'
{
  "message": "Contacts retrieved successfully.",
  "data": {
    "contacts": [
      {
        "id": "0193e6b0-9c1d-7d4f-a8f1-cef9a1b2d3e4",
        "email": "jane@example.com",
        "status": "subscribed",
        "properties": {
          "first_name": "Jane",
          "country": "US"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "lists": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "topics": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "total": 42,
      "per_page": 20,
      "current_page": 1,
      "last_page": 3
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

List contacts with pagination and filtering. Requires the audience:read scope.

Authorizations

​
Authorization
string
header
required

API key for authentication

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
per_page
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search by email or contact name

Maximum string length: 255
​
status
enum<string>

Filter by contact status

Available options:
subscribed,
unsubscribed,
bounced,
complained,
unverified
​
list_id
string<uuid>

Filter to contacts in a specific list (must belong to the team)

​
segment_id
string<uuid>

Filter to contacts matching a specific segment (must belong to the team)

Response

Contacts retrieved successfully.

​
message
string
required
Example:

"Contacts retrieved successfully."

​
data
object
required