Skip to documentation

API · Audiences

List Audiences

List audiences for your team (requires full access). This deprecated endpoint is an alias for segments.

GET/audiencesFull access

Request parameters

ParameterTypeDescription
limit
query · optional
integer
1–100
Default: 20
Number of results to return. See Pagination.
after
query · optional
stringResource ID for the next page. Cannot be combined with before. See Pagination.
before
query · optional
stringResource ID for the previous page. Cannot be combined with after. See Pagination.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X GET "$OPENSEND_BASE_URL/audiences" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "YOUR_ID",
      "name": "example",
      "created_at": "example"
    }
  ]
}

Behavior and errors

This deprecated route is an alias for the same segment records. Prefer the segments API for new integrations. Singular responses use object: "audience". The SDK’s audiences alias calls /segments, so the Node example uses the generic transport to demonstrate this legacy route.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.