Tools

Thrive

Manage users, audiences, learning and CPD on Thrive

Usage Instructions

Integrate Thrive Learning into the workflow. Manage user lifecycle, audiences and their members and managers, content assignments and enrolments, learning completions, content and activity records, CPD, tags, and skills.

Tools

`thrive_create_user`

Create a new user in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`ref`	string	Yes	Your organisation's unique identifier for this individual
`firstName`	string	Yes	The given name of the individual
`lastName`	string	Yes	The family name of the individual
`email`	string	No	The email address for the user (required unless loginMethod is 'ref')
`loginMethod`	string	No	How the user logs in: 'email' or 'ref' (defaults to 'email')
`role`	string	No	Role assigned: 'administrator', 'learneradmin', or 'learner' (defaults to 'learner')
`jobTitle`	string	No	Name of this individual's role in your organisation
`managerRef`	string	No	Your organisation's unique identifier for this individual's line manager
`startDate`	string	No	Date this individual started with your organisation (ISO 8601)
`endDate`	string	No	Date this individual left your organisation (ISO 8601)
`timeZone`	string	No	The user's preferred timezone (tenant default if omitted)
`languageCode`	string	No	The user's preferred language (e.g. 'en-gb')
`sso`	boolean	No	Whether the account is managed by an authentication provider
`domain`	string	No	Domain this individual is associated with
`additionalFields`	string	No	JSON object of custom field key-value pairs. Example: {"department":"Sales"}

Output

Parameter	Type	Description
`user`	object	The created user

`thrive_update_user`

Update an existing user in Thrive by ref. Only the fields provided are changed.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`ref`	string	Yes	The user ref to update
`firstName`	string	No	The given name of the individual
`lastName`	string	No	The family name of the individual
`email`	string	No	The email address for the user
`loginMethod`	string	No	How the user logs in: 'email' or 'ref'
`role`	string	No	Role assigned: 'administrator', 'learneradmin', or 'learner'
`jobTitle`	string	No	Name of this individual's role in your organisation
`managerRef`	string	No	Your organisation's unique identifier for this individual's line manager
`startDate`	string	No	Date this individual started with your organisation (ISO 8601)
`endDate`	string	No	Date this individual left your organisation (ISO 8601)
`timeZone`	string	No	The user's preferred timezone
`languageCode`	string	No	The user's preferred language (e.g. 'en-gb')
`sso`	boolean	No	Whether the account is managed by an authentication provider
`domain`	string	No	Domain this individual is associated with
`additionalFields`	string	No	JSON object of custom field key-value pairs. Example: {"department":"Sales"}

Output

Parameter	Type	Description
`user`	object	The updated user

`thrive_delete_user`

Permanently delete (obfuscate) a user in Thrive by ref while retaining training history.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`ref`	string	Yes	The user ref to delete

Output

Parameter	Type	Description
`success`	boolean	Whether the user was deleted

`thrive_suspend_user`

Suspend a user in Thrive by ref, marking the account inactive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`ref`	string	Yes	The user ref to suspend
`endDate`	string	No	The date this individual left your organisation (ISO 8601)

Output

Parameter	Type	Description
`user`	object	The suspended user

`thrive_search_users`

Search users in Thrive and return basic user information with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)
`updatedSince`	string	No	Return only users updated on or after this date/time (ISO 8601)
`statuses`	string	No	Comma-separated statuses to include: active, inactive, expired, new
`omitStatuses`	string	No	Comma-separated statuses to exclude: active, inactive, expired, new
`status`	string	No	Filter by a single status: active, inactive, expired, or new

Output

Parameter	Type	Description
`results`	array	The matching users
`pagination`	object	Pagination details

`thrive_get_user_by_id`

Get a single user in Thrive by their ID and return basic user information.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`id`	string	Yes	The user ID

Output

Parameter	Type	Description
`user`	object	The user

`thrive_get_user_by_ref`

Get a single user in Thrive by their ref and return basic user information.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`ref`	string	Yes	The user ref

Output

Parameter	Type	Description
`user`	object	The user (basic information)

`thrive_list_audiences`

List audiences and structures in Thrive with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`apiControlled`	boolean	No	Filter to only return audiences which are / are not API controlled
`updatedSince`	string	No	Return only audiences updated on or after this date/time (ISO 8601)
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)

Output

Parameter	Type	Description
`results`	array	The matching audiences
`pagination`	object	Pagination details

`thrive_create_audience`

Create a new audience or structure in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`name`	string	No	The name of the audience (max 100 characters)
`reference`	string	No	The external reference for the audience (max 100 characters)
`parentId`	string	No	The id or reference of the parent audience/structure; leave blank for a parent audience/structure
`category`	string	No	The audience category: 'audience' or 'structure'

Output

Parameter	Type	Description
`audience`	object	The created audience

`thrive_get_audience`

Get a single audience or structure in Thrive by id or reference.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference

Output

Parameter	Type	Description
`audience`	object	The audience

`thrive_update_audience`

Update an audience in Thrive, optionally moving it to a new parent.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`name`	string	No	The name of the audience (max 100 characters)
`reference`	string	No	The external reference for the audience (max 100 characters)
`parentId`	string	No	The id of the parent audience/structure to move the audience to

Output

Parameter	Type	Description
`audience`	object	The updated audience

`thrive_delete_audience`

Delete an audience in Thrive (only if it has no child audiences).

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference

Output

Parameter	Type	Description
`success`	boolean	Whether the audience was deleted

`thrive_list_audience_members`

List the members of a Thrive audience with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)

Output

Parameter	Type	Description
`results`	array	The audience members
`pagination`	object	Pagination details

`thrive_add_audience_members`

Add members to a Thrive audience by email, ref, or id.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`users`	string	Yes	JSON array of user emails/refs/ids to add (1-100). Example: ["user@example.com"]

Output

Parameter	Type	Description
`result`	object	The add/replace result, with successfully and unsuccessfully processed entities

`thrive_replace_audience_members`

Replace a Thrive audience's entire members list with the given users (does not support an empty array).

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`users`	string	Yes	JSON array of user emails/refs/ids that replaces the whole members list (1-100, no empty array). Example: ["user@example.com"]

Output

Parameter	Type	Description
`result`	object	The add/replace result, with successfully and unsuccessfully processed entities

`thrive_remove_audience_member`

Remove a single member from a Thrive audience.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`userRef`	string	Yes	The user email, ref, or id to remove

Output

Parameter	Type	Description
`success`	boolean	Whether the audience member was removed

`thrive_list_audience_managers`

List the managers of a Thrive audience.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference

Output

Parameter	Type	Description
`managers`	array	The audience managers

`thrive_add_audience_managers`

Add managers to a Thrive audience with their permissions.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`managers`	string	Yes	JSON array of manager objects (1-100). Each: {"reference":"user@example.com","permissions":{"audienceManager":{"manageContent":true,"assignments":true},"peopleManager":{"canViewLearnPage":true,"insights":false,"manage":false},"administrator":{"canAddAudienceManagers":false}}}

Output

Parameter	Type	Description
`result`	object	The add/replace result, with successfully and unsuccessfully processed entities

`thrive_replace_audience_managers`

Replace a Thrive audience's entire manager list with the given managers (does not support an empty array).

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`managers`	string	Yes	JSON array of manager objects that replaces the whole manager list (1-100, no empty array). Each: {"reference":"user@example.com","permissions":{"audienceManager":{"manageContent":true,"assignments":true},"peopleManager":{"canViewLearnPage":true,"insights":false,"manage":false},"administrator":{"canAddAudienceManagers":false}}}

Output

Parameter	Type	Description
`result`	object	The add/replace result, with successfully and unsuccessfully processed entities

`thrive_remove_audience_manager`

Remove a single manager from a Thrive audience.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience id or audience reference
`userId`	string	Yes	The user email, ref, or id to remove as a manager

Output

Parameter	Type	Description
`success`	boolean	Whether the audience manager was removed

`thrive_list_assignments`

List compliance assignments in Thrive, optionally filtered by audience.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	No	Filter by audience ID or audience reference
`updatedSince`	string	No	Return only items updated on or after this date/time (ISO 8601)
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-100, default 100)

Output

Parameter	Type	Description
`assignments`	array	The matching assignments

`thrive_create_assignment`

Create a compliance assignment in Thrive for an audience and content item.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceId`	string	Yes	The audience ID
`contentId`	string	Yes	The content ID for the primary content
`alternativeContentIds`	string	No	JSON array of content IDs that can also complete the assignment
`hideAlternativeContent`	boolean	No	Whether to hide the alternative content
`completionPeriod`	number	No	The number of days required to complete the assignment (default 30)
`recurrence`	number	No	The number of days until the assignment will reoccur

Output

Parameter	Type	Description
`assignment`	object	The created assignment

`thrive_get_assignment`

Get a single compliance assignment in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`assignmentId`	string	Yes	The assignment ID

Output

Parameter	Type	Description
`assignment`	object	The assignment

`thrive_update_assignment`

Update a compliance assignment in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`assignmentId`	string	Yes	The assignment ID
`audienceId`	string	Yes	The audience ID
`contentId`	string	No	The content ID for the primary content
`completionPeriod`	number	No	The number of days required to complete the assignment
`recurrence`	number	No	The number of days until the assignment will reoccur
`alternativeContentIds`	string	No	JSON array of content IDs that can also complete the assignment

Output

Parameter	Type	Description
`assignment`	object	The updated assignment

`thrive_delete_assignment`

Delete a compliance assignment in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`assignmentId`	string	Yes	The assignment ID
`audienceId`	string	Yes	The audience ID

Output

Parameter	Type	Description
`success`	boolean	Whether the assignment was deleted

`thrive_list_enrolments`

List enrolments for a compliance assignment in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`assignmentId`	string	Yes	The assignment ID
`updatedAtFrom`	string	No	Start date to filter enrolments from (ISO 8601)
`updatedAtTo`	string	No	Date to filter enrolments up to (ISO 8601). Requires updatedAtFrom.
`status`	string	No	Filter by enrolment status: archived, complete, open, overdue, scheduled, or unassigned
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-100, default 100)

Output

Parameter	Type	Description
`enrolments`	array	The matching enrolments

`thrive_get_enrolment`

Get a single enrolment for a compliance assignment in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`assignmentId`	string	Yes	The assignment ID
`enrolmentId`	string	Yes	The enrolment ID

Output

Parameter	Type	Description
`enrolment`	object	The enrolment

`thrive_list_completions`

List learning completion records in Thrive, optionally filtered by user or content.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`contentId`	string	No	Filter by content
`isRPL`	boolean	No	Filter by completions imported via Recognition of Prior Learning (RPL)
`userId`	string	No	Filter by user
`completedDateRangeStart`	string	No	Filter by completedDate (completedDate >= this date/date-time)
`completedDateRangeEnd`	string	No	Filter by completedDate (completedDate <= this date/date-time)
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 1000)

Output

Parameter	Type	Description
`completions`	array	The matching completion records

`thrive_get_completion`

Get a single learning completion record in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`id`	string	Yes	The completion ID

Output

Parameter	Type	Description
`completion`	object	The completion record

`thrive_create_completion`

Record a learning completion in Thrive for a user and content item.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`userId`	string	Yes	The user ID
`contentId`	string	Yes	The content ID for the content completed
`completedAt`	string	Yes	ISO8601 timestamp when the completion occurred

Output

Parameter	Type	Description
`statementId`	string	The completion statement ID

`thrive_get_content`

Get a single content record in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`id`	string	Yes	Unique identifier of the content item

Output

Parameter	Type	Description
`content`	object	The content record

`thrive_query_content`

Query content records in Thrive with pagination and filtering options.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 20)
`types`	string	No	Comma-separated content types (article, assessment, broadcast, cmi5, elearning, event, file, pathway, question, quiz, scorm, url, video, mixed). If both set, omitTypes is ignored.
`omitTypes`	string	No	Comma-separated content types (article, assessment, broadcast, cmi5, elearning, event, file, pathway, question, quiz, scorm, url, video, mixed). If both set, omitTypes is ignored.
`updatedSince`	string	No	Return only items updated on or after this date/time (ISO 8601)

Output

Parameter	Type	Description
`results`	array	The matching content records
`pagination`	object	Pagination details

`thrive_get_activity`

Get a single activity record in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`id`	string	Yes	Unique identifier of the activity

Output

Parameter	Type	Description
`activity`	object	The activity record

`thrive_query_activities`

Query activity records in Thrive with pagination and filtering options.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 20)
`actions`	string	No	comma-separated activity types e.g. viewed,completed
`omitActions`	string	No	comma-separated activity types e.g. viewed,completed
`contentIds`	string	No	comma-separated content IDs
`contentType`	string	No	Filter by content type
`timestampFrom`	string	No	format YYYY-MM-DD hh:mm:ss
`timestampTo`	string	No	format YYYY-MM-DD hh:mm:ss

Output

Parameter	Type	Description
`results`	array	The matching activity records
`pagination`	object	Pagination details

`thrive_get_cpd_category`

Get a single CPD category in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`categoryId`	string	Yes	The CPD category ID

Output

Parameter	Type	Description
`category`	object	The CPD category

`thrive_query_cpd_categories`

Query CPD categories in Thrive and return results with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)
`updatedSince`	string	No	Return only items updated on or after this date/time (ISO 8601)

Output

Parameter	Type	Description
`results`	array	The matching CPD categories
`pagination`	object	Pagination details

`thrive_get_cpd_entry`

Get a single CPD log entry in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`logEntryId`	string	Yes	The CPD log entry ID

Output

Parameter	Type	Description
`entry`	object	The CPD entry

`thrive_query_cpd_entries`

Query CPD log entries in Thrive and return results with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)
`entryDateFrom`	string	No	Filter entries after this date (format YYYY-MM-DD hh:mm:ss)
`entryDateTo`	string	No	Filter entries before this date (format YYYY-MM-DD hh:mm:ss)

Output

Parameter	Type	Description
`results`	array	The matching CPD entries
`pagination`	object	Pagination details

`thrive_get_cpd_requirement`

Get a single CPD requirement summary in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`audienceRequirementId`	string	Yes	The CPD requirement ID

Output

Parameter	Type	Description
`requirement`	object	The CPD requirement

`thrive_query_cpd_requirements`

Query CPD requirement summaries in Thrive and return results with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)
`updatedSince`	string	No	Return only items updated on or after this date/time (ISO 8601)

Output

Parameter	Type	Description
`results`	array	The matching CPD requirements
`pagination`	object	Pagination details

`thrive_query_cpd_user_summaries`

Query CPD user log summaries in Thrive and return results with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`entryDateFrom`	string	Yes	Filter entries after this date (format YYYY-MM-DDThh:mm:ss)
`entryDateTo`	string	Yes	Filter entries before this date (format YYYY-MM-DDThh:mm:ss)
`userIds`	string	No	Comma-separated user IDs to filter by
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)

Output

Parameter	Type	Description
`results`	array	The matching CPD user summaries
`pagination`	object	Pagination details

`thrive_list_tags`

List tags in Thrive and return tag information with pagination.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`page`	number	No	Page number for pagination (default 1)
`perPage`	number	No	Number of results per page (1-1000, default 100)
`updatedSince`	string	No	Return only tags updated on or after this date/time (ISO 8601)

Output

Parameter	Type	Description
`results`	array	The tags
`pagination`	object	Pagination details

`thrive_get_tag`

Get a single tag in Thrive by its ID.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`tagId`	string	Yes	The tag ID

Output

Parameter	Type	Description
`tag`	object	The tag

`thrive_add_user_tags`

Add one or more tags to a learner in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`userId`	string	Yes	The learner ID
`tags`	string	Yes	JSON array of tag names to add (1-100). Example: ["leadership"]

Output

Parameter	Type	Description
`status`	number	The HTTP status code of the operation
`message`	string	A human-readable result message

`thrive_remove_user_tags`

Remove one or more tags from a learner in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`userId`	string	Yes	The learner ID
`tags`	string	Yes	JSON array of tag names to remove (1-100). Example: ["leadership"]

Output

Parameter	Type	Description
`status`	number	The HTTP status code of the operation
`message`	string	A human-readable result message

`thrive_update_user_skills`

Update skills and levels for a learner in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host
`userId`	string	Yes	The learner ID
`skills`	string	Yes	JSON array of skill objects (1-100). Each: {"tagName":"leadership","level":1,"targetLevel":3}. level/targetLevel optional (min -1).

Output

Parameter	Type	Description
`status`	number	The HTTP status code of the operation
`message`	string	A human-readable result message

`thrive_get_skill_levels`

Get the available skill levels configured in Thrive.

Input

Parameter	Type	Required	Description
`tenantId`	string	Yes	Thrive Tenant ID (used as the Basic auth username)
`apiKey`	string	Yes	Thrive API key (used as the Basic auth password)
`host`	string	No	Region-specific API host

Output

Parameter	Type	Description
`levels`	array	The available skill levels

Notes

Category: tools
Type: thrive

Thinking Tinybird

On this page

On this page

Usage Instructions

thrive_create_user

thrive_update_user

thrive_delete_user

thrive_suspend_user

thrive_search_users

thrive_get_user_by_id

thrive_get_user_by_ref

thrive_list_audiences

thrive_create_audience

thrive_get_audience

thrive_update_audience

thrive_delete_audience

thrive_list_audience_members

thrive_add_audience_members

thrive_replace_audience_members

thrive_remove_audience_member

thrive_list_audience_managers

thrive_add_audience_managers

thrive_replace_audience_managers

thrive_remove_audience_manager

thrive_list_assignments

thrive_create_assignment

thrive_get_assignment

thrive_update_assignment

thrive_delete_assignment

thrive_list_enrolments

thrive_get_enrolment

thrive_list_completions

thrive_get_completion

thrive_create_completion

thrive_get_content

thrive_query_content

thrive_get_activity

thrive_query_activities

thrive_get_cpd_category

thrive_query_cpd_categories

thrive_get_cpd_entry

thrive_query_cpd_entries

thrive_get_cpd_requirement

thrive_query_cpd_requirements

thrive_query_cpd_user_summaries

thrive_list_tags

thrive_get_tag

thrive_add_user_tags

thrive_remove_user_tags

thrive_update_user_skills

thrive_get_skill_levels

Thrive