Add User Tags
-
Add One Or More Existing Tags To A Learner. Accepts An Array Of Tag Names To Associate With The Specified User.
Create Audience
-
Create A New Audience Or Structure In Thrive. First Create A Structure (Category=Structure, No ParentId), Then Create Child Audiences Within It (Category=Audience, With ParentId). API-Created Audiences Can Only Be Managed Via API.
Delete Audience
-
Delete An Audience By Its ID Or Reference. The Audience Must Not Have Any Child Audiences. Only Works For API-Controlled Audiences.
Get Activity
-
Retrieve Detailed Information For A Specific Activity By Its Unique ID. Returns Activity Data Including User, Type, Date, Context, And Associated Data.
Get Assignment
-
Retrieve Detailed Information For A Specific Assignment By Its Unique ID. Returns Assignment Data Including Audience ID, Content IDs, Completion Period, Recurrence Settings, Active Status, And Timestamps.
Get Audience
-
Retrieve Detailed Information For A Specific Audience By Its Unique ID. Returns Audience Data Including Name, Reference, Type, Category, Parent Information, And Timestamps.
Get CPD Category
-
Retrieve Detailed Information For A Specific CPD Category By Its Unique ID. Returns The Category ID And Name.
Get CPD Entry
-
Retrieve Detailed Information For A Specific CPD Entry By Its Unique ID. Returns Entry Data Including User, Activity Type And Name, Category, Duration In Minutes, Description, And Verification Status.
Get CPD Requirement
-
Retrieve Detailed Information For A Specific CPD Requirement Summary By Its Unique ID. Returns Requirement Data Including Audience Requirement ID, Audience ID, Required Minutes, And Creation/Update Timestamps.
Get Completion
-
Retrieve Detailed Information For A Specific Completion Record By Its Unique ID. Returns Completion Data Including User ID, Content ID, Content Version, Skills Acquired, Completion Type, RPL Status, And Timestamps.
Get Content
-
Retrieve Detailed Information For A Specific Content Item By Its Unique ID. Returns Comprehensive Content Data Including Title, Description (HTML), Tags, Type, Author, Official Status, And Timestamps.
Get Enrolment
-
Retrieve Detailed Information For A Specific Enrolment By Its Unique ID. Returns Enrolment Data Including User ID, Assignment ID, Status, Available Date, Due Date, Last Completion Date, And Event History.
Get Tag
-
Retrieve Detailed Information For A Specific Tag By Its Unique ID. Returns Tag Data Including Associated Contents, Interests, Skills, And Campaigns.
Get User
-
Retrieve Detailed Information For A Specific User By Their Unique ID. Returns Comprehensive User Data Including Name, Email, Role, Status, Positions, Followers, Tags, Rank, And Profile Information.
Get User By Ref
-
Search And Retrieve Basic User Information By Their Unique Reference Code. Returns User Data Including Name, Email, Role, Status, Positions, And Language Preferences.
List Activities
-
Retrieve A Paginated List Of User Activities From The Thrive Platform. Supports Filtering By Activity Types, Content IDs, Content Type, And Date Range. Returns Activity Metadata Including User, Type, Date, And Context Information.
List Assignments
-
Retrieve A Paginated List Of Content Assignments For A Specific Audience. Returns Assignment Metadata Including Content IDs, Completion Period, Recurrence Settings, And Status. Assignments Represent Content Items Assigned To Audiences For Completion Within Set Time Periods.
List Audience Managers
-
Retrieve The List Of Managers For A Specific Audience. Returns Manager User IDs, Emails, References, And Their Permissions Including Audience Manager, People Manager, And Administrator Rights.
List Audience Members
-
Retrieve A Paginated List Of Members Belonging To A Specific Audience. Returns User IDs, Emails, And References.
List Audiences
-
Retrieve A Paginated List Of All Audiences From The Thrive Platform. Returns Audience Metadata Including Name, Reference, Type, Category, And Parent Information. Supports Filtering By API Controlled Status.
List CPD Categories
-
Retrieve A Paginated List Of CPD (Continuing Professional Development) Categories From The Thrive Platform. Returns Category Metadata Including ID And Name. Useful For Categorizing And Tracking Professional Development Activities.
List CPD Entries
-
Retrieve A Paginated List Of CPD (Continuing Professional Development) Entries From The Thrive Platform. Returns Entry Metadata Including User, Activity Type, Category, Duration, And Verification Status. Supports Date Range Filtering.
List CPD Requirements
-
Retrieve A Paginated List Of CPD (Continuing Professional Development) Requirement Summaries From The Thrive Platform. Returns Requirement Metadata Including Audience ID, Required Minutes, And Timestamps.
List CPD User Summaries
-
Retrieve CPD (Continuing Professional Development) Log Summaries Per User From The Thrive Platform. Returns Aggregated Total Minutes Logged By Each User Within A Specified Date Range. Requires Date Range Parameters.
List Completions
-
Retrieve A Paginated List Of Content Completion Records For A Specific User. Returns Completion Metadata Including Content ID, Skills Acquired, Completion Type, And Timestamps. Supports Filtering By Content, RPL Status, And Date Range.
List Contents
-
Retrieve A Paginated List Of All Learning Content Items From The Thrive Platform. Returns Content Metadata Including Title, Description, Tags, Type, Author, And Timestamps. Supports Pagination For Large Content Libraries.
List Enrolments
-
Retrieve A Paginated List Of Enrolments For A Specific Assignment. Returns Enrolment Metadata Including User ID, Status, Dates, And Completion History. Enrolments Track The Completion Process For Users Assigned To Content.
List Skill Levels
-
Retrieve The Available Skill Levels Configured In The Thrive Platform. Returns Skill Level Metadata Including Name, Enabled Status, And Numeric Value. Useful For Understanding The Skill Proficiency Scale Used In The System.
List Tags
-
Retrieve A Paginated List Of All Tags From The Thrive Platform. Returns Tag Metadata Including Associated Contents, Interests, Skills, And Campaigns.
List Users
-
Search And Retrieve A List Of All Users In The Thrive Learning Platform With Pagination Support. Returns Basic User Information Including Name, Email, Role, Status, Compliance Score, And Learning Progress. Useful For User Management, Reporting, And Analytics.
Remove Audience Manager
-
Remove A Manager From An Audience. Only Works For API-Controlled Child Audiences (Category: 'Audience'), Not Parent Structures (Category: 'Structure').
Remove Audience Member
-
Remove A Single User From An Audience. Only Works For API-Controlled Child Audiences (Category: 'Audience'), Not Parent Structures (Category: 'Structure').
Remove User Tags
-
Remove One Or More Existing Tags From A Learner. Uses JSON Patch Format To Specify Tags To Remove.
Update Audience
-
Update An Existing Audience'S Name And/Or Reference. Only Works For API-Controlled Audiences.
Update User Skills
-
Update Level And/Or Target Level For One Or More Skills For A Learner. Allows Setting Skill Proficiency Levels And Target Goals.
.svg)
