Skip to main content
POST
/
api
/
v1
/
audience
/
get-audience-list
List Audiences
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/audience/get-audience-list \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "pagination": {
    "limit": 50,
    "offset": 0
  }
}
'
{
  "audiences": [
    {
      "audience_id": 123,
      "audience_name": "<string>",
      "audience_type": "<string>"
    }
  ],
  "total_count": 123,
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total_count": 123,
    "has_more": true
  }
}

Headers

X-API-Key
string
required
X-User-ID
string
required

Body

application/json

Request to list audiences with optional pagination.

pagination
PaginationParams · object

Pagination parameters for the request

Response

Successful Response

Paginated response for audience list.

audiences
Audience · object[]
required
total_count
integer
required
pagination
PaginationMetadata · object

Pagination metadata (included when pagination is requested)