Audience

List audience lists

Returns all audience lists for the authenticated team. Requires the audience:read scope.

get/audience/lists

Request

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

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (max 100)

Response

Lists retrieved successfully.

messagestring required

Example response

{
  "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
    }
  }
}

Changes

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