Audience

List audience segments

List segments with pagination. Requires the audience:read scope.

get/audience/segments

Request

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

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (max 100)

list_idstring uuid

Filter to segments restricted to a specific list (must belong to the team)

Response

Segments retrieved successfully.

messagestring required

Example response

{
  "message": "Segments retrieved successfully.",
  "data": {
    "segments": [
      {
        "name": "Engaged subscribers",
        "condition_groups": [
          {
            "conditions": [
              {
                "field": "email",
                "operator": "equals",
                "value": "@example.com"
              }
            ]
          }
        ]
      }
    ],
    "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.