API Reference

Get audiences

get
https://platform.{env}.simpplr.com/v1/b2b/identity/audiences

This API allows you to retrieve a list of all audiences for the tenant.

Query Params
integer
Defaults to 10

The number of audiences to return per page.

string

Should be what is returned as nextPageToken from a previous page request if passed.

boolean
Defaults to false

Whether to include the total number of users in the response. To include set it to true

string

Search term to filter audiences by name

string

Audience category ID to filter by.

This is valid for only ABAC enabled tenants. For non-ABAC tenants, if you pass anything here it will throw error.

string

Parent audience ID to filter by.

This is valid for only ABAC enabled tenants. For non-ABAC tenants, if you pass anything here it will throw error.

Responses

Updated 2 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago