Returns all audiences (up to 100 per page) for a tenant, regardless of whether they are API controlled or not.
HTTP Basic authentication using your Tenant ID and API secret.
- Username is the Tenant ID (i.e.
eu-west-2_AbcdEfghI) - Password is the API secret you would have received.
You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.
OAuth 2.0 client credentials authentication.
Use the following token endpoints (replace :tenantId with your Tenant ID):
Public API access tokens
- Staging:
https://public.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://public.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://public.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://public.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
Webhooks access tokens
- Staging:
https://user.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://user.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://user.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://user.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
All access tokens must be sent using the Authorization: Bearer <access_token> header.
Scopes
For API access (non-webhooks), the following scopes are available:
api/all– Full read and write access to the API.api/read– Read-only access to the API.api/write– Write access to the API.
For webhooks, the following scopes are available:
api/webhooks– Access to webhook functionality.api/all– Full read and write access to the API, including webhooks.
Tokens must include appropriate scopes for the endpoints you wish to call.
Filter to only return audiences which are / are not api controlled.
Return only items updated on or after this date/time (ISO 8601).
Used in combination with the limit parameter to page through the data.
Used in combination with the page parameter to page through the data.
Used in combination with the page parameter to page through the data.
Comma-separated list of extra data to nest into each audience. Omit it and the response is unchanged.
managers- every user holding a management role on the audience (audience manager, people manager or administrator), with the full permission set for each role they hold.
Values are case-insensitive. Any other value is rejected with a 400, matching the expand parameter on the users endpoints; this endpoint's other query parameters fail with a 422.
An array of Thrive audiences
An audience, with its managers when expand=managers is requested.
The id of the created resource
The name of the audience
The external reference for the Audience
Whether the audience is API controlled or not. API-controlled audiences:
- Can only be updated via the API, not through the Thrive UI
- Must be created using this API (existing UI-created audiences cannot be converted)
- API-created audiences can only exist within API-created structures
- Are always of type 'manual' (not 'smart')
Category of Audience: * structure - Structure, a top-level/parent audience. Created without a parentId. Represents an organizational unit. * audience - Audience, a child audience that exists within a structure. Created with a parentId. The workflow for creating audiences requires first creating a structure (category=structure, no parentId), then creating child audiences within that structure (category=audience, with parentId). A structure may contain multiple child audiences, but each audience can only belong to one structure. When a structure is deleted, all its child audiences are also deleted. See the Audience Workflow Documentation for hierarchy examples.
Type of Audience: * smart - Audience membership is controlled by smart rules. * manual - Audience membership is managed manually. Note: Audiences created via the API are always of type 'manual'. Smart audiences can only be created through the Thrive UI. API-controlled audiences cannot be converted to smart audiences.
Information on the parent audience/ structure - only available on a child audience.
The name of the audience
The external reference for the Audience
The id of the parent audience/ structure.
The DateTime the audience was created at.
The DateTime the audience was last updated at.
Present only when expand=managers is given. Every user holding a management role on the audience, one entry per user.
A user holding one or more management roles on an audience, with the full permission set for each role they hold.
The user's id.
The user's reference. Null if the user record cannot be found; the role is still reported.
The user's email. Null if the user record cannot be found; the role is still reported.
Whether the user has been deleted. Deleted users who still hold a role are reported rather than hidden, so stale grants stay visible.
The permissions a user holds on a single audience, grouped by the role that grants them. A role key is present only if the user holds that role on the audience, so the keys present are themselves the role attribution.
The administrator permissions set - only available on structures/ parent audiences.
Whether the user can create/edit child audiences.
Whether the user can add or edit managers for child audiences.
The audience manager permissions set
Whether the user can add/remove members for the audience.
Whether the user can manage users within the audience.
Whether the user can share/unshare content for the audience.
Whether the user can create/edit/remove assignments for the audience.
Whether the user can view analytics for audience members.
The people manager permissions set
Whether the user can view analytics and reports.
Whether the user can view insights into how the audience is using content and search.
Whether the user can add/edit goals for audience members.
Whether the user can manage audience members.
Whether the user can view the learn page of audience members.
Whether the user can run compliance reports on assignments associated to audience members.
Details of the pagination
Total number of results matching the query
Total number of pages available
Current page number
Number of results per page
Bad Request
Bad Request
Unauthorized
Unauthorized
Forbidden
Forbidden
Conflict
Conflict
Unprocessable Content
Unprocessable Content
Internal Server Error
Internal Server Error