List Segments

GET

/api/v3/audience/segments

List your custom audience segments across all of your channels. At present, our API doesn’t include dynamic segments that Letterhead provides. Our v3 API requires a company-level API key.

Authorizations

• bearerAuth

Parameters

Query Parameters

api

string

Example

true

Responses

200

List Segments

Media type text/plain

Examples

Example List Segments

{
    "items": [
        {
            "uniqueId": 1,
            "channel": "black-bitter-coffee",
            "name": "Testaroo",
            "createdAt": "2025-07-24 01:28:39",
            "updatedAt": "2025-11-15 03:00:31",
            "criteria": [
                {
                    "attribute": "tags",
                    "category": "tags",
                    "operator": "IN",
                    "value": [
                        "Staff"
                    ]
                },
                {
                    "attribute": "tags",
                    "category": "tags",
                    "operator": "IN",
                    "value": [
                        "Border-collies"
                    ]
                },
                {
                    "attribute": "age",
                    "category": "commonFields",
                    "operator": ">",
                    "value": "3"
                }
            ],
            "isOrBoolean": false
        },
    ],
    "message": "",
    "total": 1
}

Headers

Alt-Svc

string

Example

h3=":443"; ma=2592000

Transfer-Encoding

string

Example

chunked

access-control-allow-credentials

string

Example

true

access-control-allow-origin

string

Example

*

access-control-max-age

string

Example

86400

cache-control

string

Example

no-cache, private

date

string

Example

Thu, 16 Apr 2026 19:04:43 GMT

server

string

Example

nginx/1.27.3

via

string

Example

1.1 google

x-powered-by

string

Example

PHP/7.4.33