Gets an audience members list.

Prev Next
Get
/audiences/{audienceId}/members

Takes in an audience id/reference and returns its members.

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Path parameters
audienceId
stringRequired

Filter by audienceId or audience reference.

Example63f57d805d8ecbf46f5b5278
Query parameters
page
number

Used in combination with the limit parameter to page through the data.

Default1.0
Example1.0
perPage
number

Used in combination with the page parameter to page through the data.

Minimum1.0
Maximum1000.0
Default100.0
Example50.0
limit
number

Used in combination with the page parameter to page through the data.

Minimum1.0
Maximum100.0
Default100.0
Example50.0
Responses
200

An array of audience members.

Expand All
object
results
Array of object (AudienceMember)
object

The audience member object.

userId
string

The user's id.

Example63f8c5361b9c80d3274be7ca
reference
string

The user's reference.

Exampleuser123
email
string

The user's email.

Exampletest@thrivelearning.com
pagination
object (Pagination)

Details of the pagination

totalResults
integer

Total number of results matching the query

Example48
totalPages
integer

Total number of pages available

Example3
page
integer

Current page number

Minimum1.0
Default1
Example1
perPage
integer

Number of results per page

Minimum1.0
Maximum1000.0
Default100
Example20
401

Unauthorized

object

Unauthorized

status
number
Example401.0
error
string
ExampleUnauthorized
message
string
403

Forbidden

object

Forbidden

status
number
Example403.0
error
string
ExampleForbidden
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
409

Conflict

object

Conflict

status
number
Example409.0
error
string
ExampleConflict
message
OneOf
string
string
object
object
422

Unprocessable Content

object

Unprocessable Content

status
number
Example422.0
error
string
ExampleUnprocessable Content
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
default

Internal Server Error

object

Internal Server Error

status
number
Example500.0
error
string
ExampleInternal Server Error
message
string