Audience

List audience contacts

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

get/audience/contacts

Request

  • Base URL: https://app.lettr.com/api
  • URL: https://app.lettr.com/api/audience/contacts
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (max 100)

searchstring

Search by email or contact name

status'subscribed' | 'unsubscribed' | 'bounced' | 'complained' | 'unverified'

Filter by contact status

list_idstring uuid

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

segment_idstring uuid

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

Response

Contacts retrieved successfully.

messagestring required

Example response

{
  "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"
      }
    ],
    "pagination": {
      "total": 42,
      "per_page": 20,
      "current_page": 1,
      "last_page": 3
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.