Skip to main content
GET
/
audiences
Get Audiences
curl --request GET \
  --url https://api.audiencelab.io/audiences \
  --header 'X-Api-Key: <api-key>'
{
  "total_records": 50,
  "page_size": 100,
  "page": 1,
  "total_pages": 1,
  "data": [
    {
      "id": "aa1a0c14-2dff-4389-b025-06a308df9ee9",
      "name": "My Test Audience",
      "next_scheduled_refresh": null,
      "scheduled_refresh": false,
      "refresh_interval": null,
      "webhook_url": null
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:100

Number of items per page (max 1000)

Required range: 1 <= x <= 1000

Response

Successfully retrieved audiences list

​
total_records
integer
Example:

50

​
page_size
integer
Example:

100

​
page
integer
Example:

1

​
total_pages
integer
Example:

1

​
data
object[]