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

Documentation Index

Fetch the complete documentation index at: https://docs.openfunnel.dev/llms.txt

Use this file to discover all available pages before exploring further.

Headers

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

Query Parameters

​
limit
integer
default:50

Maximum number of items to return per page (1-500)

Required range: 1 <= x <= 500
​
offset
integer
default:0

Number of items to skip before starting to return results

Required range: x >= 0

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)