Skip to main content
GET
/
audience
/
lists
List audience lists
curl --request GET \
  --url https://app.lettr.com/api/audience/lists \
  --header 'Authorization: Bearer <token>'
{
  "message": "Lists retrieved successfully.",
  "data": {
    "lists": [
      {
        "id": "0193e6a8-1f3a-7c2a-b9e2-1aa1d2e5d3f0",
        "name": "Newsletter subscribers",
        "contacts_count": 124
      }
    ],
    "pagination": {
      "total": 42,
      "per_page": 20,
      "current_page": 1,
      "last_page": 3
    }
  }
}
Returns all audience lists for the authenticated team. 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

Response

Lists retrieved successfully.

​
message
string
required
Example:

"Lists retrieved successfully."

​
data
object
required