Thrive Learning

App · 25 actions

Manage learners, audiences, learning content, completions and events in Thrive Learning.

Actions

ActionWhat it does
Add audience membersAdd users to an audience's members list.
Archive contentArchive a content record.
Create audienceAdd a new audience.
Create completionCreate a completion record.
Create contentCreate a content record.
Create userCreate a user.
Delete audienceDelete an audience.
Delete userDelete a user.
Get audienceGet an audience.
Get contentGet a single content record.
Get eventGet a single event.
Get userSearch user by ID and return basic user information.
List audience membersGet an audience members list.
List audiencesGet audiences.
List completionsGet a list of completion records.
List contentQuery content records.
List eventsList events.
List usersSearch users and return basic user information.
List webhook eventsQuery stored outbound webhook events.
Publish contentPublish a content record.
Reactivate userReactivate a suspended user.
Remove audience memberRemoves an audience member.
Suspend userSuspend a user.
Update contentUpdate a content record.
Update userUpdate a user.

Add audience members

Add users to an audience's members list.

Inputs

Audienceaudience_idtextRequired
Filter by audienceId or audience reference.
ValuesvalueslistRequired
Values to send, using the fields documented by the app.

Outputs

Value.

dataobject
A success response for adding members/managers.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "success": {
      "count": 1,
      "entities": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Archive content

Archive a content record.

Inputs

IdidtextRequired
Unique identifier of the content item
Author refauthor_reftextRequired
Your organisation's reference for the acting user. The status change is recorded against this user, and on a restore that user also becomes the recorded publisher. A suspended or deleted user is rejected.

Outputs

Value.

dataobject
The content after a lifecycle transition, in the same shape as `GET /contents/{id}`. Answered by publish, archive and restore, so that a caller reads one shape from all three. Unlike the create and the update, a transition adds no upload URLs. In the rare case that the transition was made but the record could not be read back, the response is the minimal form: `id` and `status` only. The transition holds in both cases , do not retry the request; a retry answers 409. A full body also satisfies the minimal shape, so this is `anyOf`.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create audience

Add a new audience.

Inputs

Namenametext
The name of the audience.
Referencereferencetext
The external reference for the Audience.
Parent IDparent_idtext
The id or reference of the parent audience/ structure, this will be blank if it is a parent audience/ structure.
Categorycategorytext
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](https://docs.thrivelearning.com/apidocs/understanding-the-audiences-api-workflows#audience-hierarchy-management) for hierarchy examples.One of: audience, structure.

Outputs

Value.

dataobject
A audience object.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "apiControlled": true,
    "category": "audience",
    "createdAt": "2026-10-01T12:00:00Z",
    "id": "63f8c5361b9c80d3274be7ca",
    "name": "Tech Team",
    "parent": {
      "id": "673db100e5c0503ac23b0e2b",
      "name": "Tech Team",
      "reference": "audience123"
    },
    "reference": "audience123",
    "type": "manual",
    "updatedAt": "2026-10-01T12:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

Create completion

Create a completion record.

Inputs

Record user IDrecord_user_idtextRequired
The user ID
Contentcontent_idtextRequired
The content ID for the content completed
Completed atcompleted_atdate and timeRequired
An ISO8601 for the timestamp when the completion occurred
Current completioncurrent_completiontrue/false
Whether this is a live, on-system completion. Defaults to false, which treats the record as a historic completion (imported Recognition of Prior Learning) so it does not reset assignment due dates. Set to true to record a live completion that updates due dates as the most recent completion.

Outputs

Value.

dataobject
The identifier of the completion statement that was recorded. This is not a completion ID. Statement IDs and completion IDs are separate identifier spaces, so a statement ID cannot be passed to `GET /learning/completions/{id}`, which expects a completion ID and will return `422` for a statement ID. To retrieve the completion itself, query `GET /learning/completions` filtered by `userId` and `contentId`.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "statementId": "7e34859f-6364-5315-82d9-1b16dfadee01"
  },
  "has_more": false,
  "next_cursor": null
}

Create content

Create a content record.

Inputs

TitletitletextRequired
Title for this request.
Language codelanguage_codetextRequired
The content language. The value is case-insensitive and is normalised to a code on the Thrive supported-languages list before the content is created: en, en-GB and en_gb are all stored as en-gb, and fr-FR is stored as fr. A regional variant without its own entry is mapped to the nearest supported code, which is not always the bare language code: es-AR is stored as es-mx and en-IE as en-gb. Norwegian is the one code stored with an upper-case region: no, nb and nn are stored as no-NO. A code that cannot be resolved is rejected with a 422.
Author refauthor_reftextRequired
Your organisation's reference for the acting user. The user becomes the recorded actor, and the author unless a collaboration owns the content. The user must be active. A new, suspended, expired or deleted user is rejected.
Collaboration IDcollaboration_idtext
The collaboration that owns the content. The authorRef user must be a member of it, or the request is rejected with 422.
Publish when readypublish_when_readytrue/false
Publish automatically when the content becomes ready: every item has completed processing and the content has a thumbnail. Send thumbnail to get a thumbnail upload URL in the same response; without a thumbnail the content stays created. The flag is stored so the publish happens as soon as the record is ready.
Skillsskillslist
Skills to associate with the content. Each name must be an existing skill in your organisation, or the request is rejected with 422. Only accepted together with publishWhenReady: true. Stored in the content tags alongside the topics.
Topicstopicslist
Topics to associate with the content. Free names; a topic is not checked against your organisation's tags. Only accepted together with publishWhenReady: true. Stored in the content tags alongside the skills. A name cannot appear in both lists.
Primary categoryprimary_categorytext
The content type category a caller can set on mixed content, as the platform shows it on content cards and filters search on it. standard is displayed as "Mixed". A token outside this list is rejected with 422; event, pathway and question exist on the platform for legacy search filtering only and cannot be set here. The value is case insensitive and is stored in lower case. Omitted on create, a default is inferred: elearning when the content holds an e-learning item, otherwise standard. Omitted on update, the stored category is unchanged: an update never re-infers elearning, so content that gains its first e-learning item after create keeps standard until an update sets the category. The category cannot be cleared: null is rejected with 422. Set it on create or with PATCH /contents/{id}; the publish endpoint does not take it.One of: file, article, elearning, url, quiz, assessment, video, standard.
Completion typecompletion_typetext
How the content is completed. Defaults to auto. auto, confirm and external apply to any content; on_elearning_completion requires an e-learning item. on_clicking_links requires at least one URL item with a non-empty location that is not a YouTube video, otherwise returns 409. The quiz, assessment and interactive types require item types this API cannot create yet, so they are rejected with a 409.One of: auto, confirm, external, on_passing_quizzes, on_passing_observer_completed_quizzes, on_passing_assessments, on_elearning_completion, on_completing_interactive, on_clicking_links.
Custom duration in mscustom_duration_in_msnumber
A custom duration in milliseconds.At least 1.
Is officialis_officialtrue/false
Create the content as endorsed by your organisation. Defaults to false.
Cpd category IDcpd_category_idtext
The CPD category to record this content against. Only accepted together with isOfficial: true (400 otherwise). The category must exist in your organisation (422 otherwise).
Thumbnailthumbnailobject
Asks for a thumbnail upload URL. The content thumbnail is uploaded like an item file: give the upload a UUID here and PUT the image bytes (JPEG, PNG, GIF or WebP) to the signedPutUrls entry that echoes it. The uploadId is not stored; it only pairs this request with its response entry, so it must differ from every item uploadId in the same request (400 otherwise). A content has one thumbnail, and a later upload replaces it. Processing is asynchronous: the thumbnail counts for readiness once the image has been resized and stored.
Itemsitemslist
The content items. At most one upload item (elearning, video or image) plus one non-upload item (rich_text or url) per request. Each rank must be unique.

Outputs

Value.

dataobject
The created content with its presigned upload URLs. In the rare case that the content was created but could not be read back, the response is the minimal form: `id`, `status` and `signedPutUrls` only. The content exists in both cases , do not retry the request. A full body also satisfies the minimal shape, so this is `anyOf`.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create user

Create a user.

Inputs

RefreftextRequired
Your organisation's unique identifier for this individual
First namefirst_nametextRequired
The given name of the individual
Last namelast_nametextRequired
The family name of the individual
Emailemailtext
The email address for the user. Required unless loginMethod is 'ref'.
Login methodlogin_methodtext
How the user logs in. Defaults to 'email'.One of: email, ref.
Roleroletext
The role assigned to this individual. Defaults to 'learner' if omitted.One of: administrator, learneradmin, learner.
Job titlejob_titletext
The name of this individual's role in your organisation
Manager refmanager_reftext
Your organisation's unique identifier for this individual's line manager
Start datestart_datedate and time
The date this individual started working with your organisation
End dateend_datedate and time
The date this individual left your organisation
Time zonetime_zonetext
The user's preferred timezone. If not provided the tenant default is used.
Language codelanguage_codetext
The user’s preferred language. If not provided the tenant default is used. One caveat is that the tenant may only use the languages they have requested.One of: cs, de, en-gb, en-us, es, es-mx, fi, fr, hu, id, and 13 more.
Ssossotrue/false
Whether this account is managed by an Authentication provider or not.
Domaindomaintext
The domain this individual is associated with
Additional fieldsadditional_fieldsobject
Custom field key-value pairs matching your configured custom fields.

Outputs

Value.

dataobject
A user lifecycle resource returned by the v2 user lifecycle endpoints
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active": true,
    "additionalFields": {},
    "createdAt": "2021-08-18T13:48:00+00:00",
    "domain": "tenant.learn.link",
    "email": "user@thrivelearning.com",
    "endDate": "2021-06-11T16:00:00Z",
    "firstName": "Thomas",
    "id": "6143eedfd39243e830bdbb8c",
    "jobTitle": "Director",
    "languageCode": "en-gb",
    "lastName": "Jefferson",
    "loginMethod": "email",
    "managerRef": "UID0034234555",
    "ref": "UID30084022",
    "role": "learner",
    "sso": true,
    "startDate": "2021-01-01T09:00:00+00:00",
    "timeZone": "Europe/London",
    "updatedAt": "2021-08-19T18:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

Delete audience

Delete an audience.

Inputs

Audienceaudience_idtextRequired
Filter by audienceId or audience reference.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Delete user

Delete a user.

Inputs

RefreftextRequired
The user ref

Outputs

Value.

dataobject
Response returned when a user is successfully deleted
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "success": true
  },
  "has_more": false,
  "next_cursor": null
}

Get audience

Get an audience.

Inputs

Audienceaudience_idtextRequired
Filter by audienceId or audience reference.

Outputs

Value.

dataobject
A audience object.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "apiControlled": true,
    "category": "audience",
    "createdAt": "2026-10-01T12:00:00Z",
    "id": "63f8c5361b9c80d3274be7ca",
    "name": "Tech Team",
    "parent": {
      "id": "673db100e5c0503ac23b0e2b",
      "name": "Tech Team",
      "reference": "audience123"
    },
    "reference": "audience123",
    "type": "manual",
    "updatedAt": "2026-10-01T12:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

Get content

Get a single content record.

Inputs

IdidtextRequired
Unique identifier of the content item

Outputs

Value.

dataobject
The record `GET /contents/{id}` returns: the content, plus its `thumbnail` when the record is served from content-core. The v2 create, update and publish responses and the `GET /contents` list never carry `thumbnail`; read the record by its id to get it.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "author": "5c8936159ec2d00010cdd334",
    "contentHistory": [],
    "cpdCategoryId": "507f1f77bcf86cd799439012",
    "createdAt": "2019-03-13T16:15:24Z",
    "description": "This content looked really interesting and relevant to recent conversations in the development team",
    "duration": {
      "unit": "minutes",
      "value": 15
    },
    "id": "5c8936159ec2d00010cdd334",
    "isOfficial": true,
    "items": [],
    "lastUpdatedBy": {
      "email": "example",
      "id": "example",
      "reference": "example"
    },
    "primaryCategory": "elearning",
    "provider": {
      "id": "thrive",
      "name": "Thrive"
    },
    "skills": [],
    "status": "published",
    "tags": [],
    "thumbnail": {
      "updatedAt": "2026-10-02T09:00:00Z",
      "url": "https://cdn.example.com/processed/content-core/5f9d88d6e1b2a34c56d78901/thumbnail/507f1f77bcf86cd799439011.jpeg?2026-10-02T09:00:00.000Z"
    },
    "title": "An amazing video",
    "topics": [],
    "type": "video",
    "updatedAt": "2019-03-13T16:15:24Z"
  },
  "has_more": false,
  "next_cursor": null
}

Get event

Get a single event.

Inputs

IdidtextRequired
The event id

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "attendeeCount": 34,
    "canReshare": true,
    "cancellationPeriod": 2,
    "createdAt": "2024-01-10T09:00:00Z",
    "eventLog": [],
    "id": "64a1f2b3c4d5e6f7a8b9c0d1",
    "isAllowedToComment": true,
    "isCancellationRestricted": true,
    "lastUpdatedBy": {
      "email": "author@example.com",
      "id": "64a1f2b3c4d5e6f7a8b9c0d2",
      "reference": "EMP123"
    },
    "managerTeamEnrolmentEnabled": true,
    "occurrenceCount": 2,
    "occurrences": [],
    "selfRegistrationEnabled": true,
    "status": "published",
    "title": "Leadership Workshop Q1",
    "truncated": {
      "attendees": false,
      "occurrences": false
    },
    "type": "event",
    "updatedAt": "2024-06-15T10:30:00Z",
    "waitlistDisabled": false
  },
  "has_more": false,
  "next_cursor": null
}

Get user

Search user by ID and return basic user information.

Inputs

IdidtextRequired
Filter by user
Expandexpandtext
Comma-separated list of extra data to nest into the response. Omit it and the response is unchanged. - permissions - every permission domain currently supported, today audiences and spaces. New domains are added to this token over time. - audiencePermissions - audience management permissions only. - spacePermissions - space permissions only. When any permission domain is expanded the maximum perPage is reduced from 1000 to 100.

Outputs

Value.

dataobject
A user object
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "additionalFields": {},
    "agreedTerms": true,
    "audiences": [
      "646767d82535201223349e09"
    ],
    "compliance": 0,
    "createdAt": "2021-01-01T09:00:00+00:00",
    "deleted": false,
    "email": "sample@thrivelearning.com",
    "firstLogin": "2021-01-01T09:00:00+00:00",
    "firstName": "John",
    "hasPicture": false,
    "id": "646767d82535201223349e09",
    "languageCode": "en-gb",
    "lastLogin": "2021-01-01T09:00:00+00:00",
    "lastName": "Doe",
    "level": 0,
    "onboarded": true,
    "permissions": {
      "audiences": [],
      "spaces": []
    },
    "positions": [],
    "rank": {
      "currentCategory": "Beginner",
      "currentRank": 1
    },
    "ref": "xyzabc",
    "relevancy": 0,
    "role": "learner",
    "singleSignOn": true,
    "status": "active",
    "summary": "A summary of the user",
    "tags": {
      "skillLevels": [],
      "skills": [
        "communication",
        "leadership"
      ]
    },
    "tagsFollowing": [
      "646767d82535201223349e09"
    ],
    "timeZone": "Europe/London",
    "updatedAt": "2021-01-01T09:00:00+00:00",
    "usersFollowing": [
      "646767d82535201223349e09"
    ]
  },
  "has_more": false,
  "next_cursor": null
}

List audience members

Get an audience members list.

Inputs

Audienceaudience_idtextRequired
Filter by audienceId or audience reference.
Pagepagenumber
Used in combination with the limit parameter to page through the data.
Per pageper_pagenumber
Used in combination with the page parameter to page through the data.From 1 to 100.
Limitlimitnumber
Used in combination with the page parameter to page through the data.From 1 to 100.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "pageNumber": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List audiences

Get audiences.

Inputs

Api controlledapi_controlledtrue/false
Filter to only return audiences which are / are not api controlled.
Updated sinceupdated_sincedate and time
Return only items updated on or after this date/time (ISO 8601).
Pagepagenumber
Used in combination with the limit parameter to page through the data.
Per pageper_pagenumber
Used in combination with the page parameter to page through the data.From 1 to 100.
Limitlimitnumber
Used in combination with the page parameter to page through the data.From 1 to 100.
Expandexpandtext
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.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List completions

Get a list of completion records.

Inputs

Contentcontent_idtext
Filter by content
Is rplis_rpltrue/false
Filter by completions imported via RPL
Record user IDrecord_user_idtext
Filter by user
Completed date range startcompleted_date_range_starttext
Filter by completedDate (completedDate >= completedDateRangeStart)
Completed date range endcompleted_date_range_endtext
Filter by completedDate (completedDate <= completedDateRangeEnd)
Pagepagenumber
Set the current page of resultsAt least 1.
Per pageper_pagenumber
Used in combination with the page parameter to page through the data, will be prioritised over limit. **Allowed values: 1, 1000**From 1 to 1000.
Limitlimitnumber
Set the number of items to retrieve per pageFrom 1 to 1000.

Outputs

Value.

datalist
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List content

Query content records.

Inputs

Pagepagenumber
Page number for paginationAt least 1.
Per pageper_pagenumber
Number of records per pageFrom 1 to 1000.
Typestypestext
Only return content whose type is in this list (comma-separated, case-insensitive). Allowed values: article, assessment, broadcast, cmi5, elearning, event, file, pathway, question, quiz, scorm, url, video, mixed. If both types and omitTypes are provided, only types is applied; omitTypes is ignored.
Omit typesomit_typestext
Exclude content whose type is in this list (comma-separated, case-insensitive). Allowed values: article, assessment, broadcast, cmi5, elearning, event, file, pathway, question, quiz, scorm, url, video, mixed. Ignored when types is also provided.
Statusesstatusestext
Only return content whose state is in this list (comma-separated, case-insensitive). Allowed values: created, published, archived, deleted. When used with omitStatuses, results must match an included status and must not match any omitted status. Note: deleted filters on the deletion flag, not on the response status field. A deleted record reports its pre-deletion status (created, published or archived), so the returned status values do not match this filter value.
Omit statusesomit_statusestext
Exclude content whose state is in this list (comma-separated, case-insensitive). Allowed values: created, published, archived, deleted. When statuses is not provided, non-omitted lifecycle states keep the default catalogue behaviour (non-archived and non-deleted), unless archived or deleted is listed here. Note: deleted filters on the deletion flag, not on the response status field. A deleted record reports its pre-deletion status (created, published or archived).
Updated sinceupdated_sincedate and time
Return only items updated on or after this date/time (ISO 8601).

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List events

List events.

Inputs

Pagepagenumber
Page number for paginationAt least 1.
Per pageper_pagenumber
Number of records per pageFrom 1 to 100.
Statusstatustext
Comma-separated list of lifecycle states to include. When omitted, archived events are excluded.One of: created, published, archived.
Updated sinceupdated_sincedate and time
Returns only events whose **metadata** changed after this timestamp (title, description, status, occurrence and session edits). Attendee activity does not update this timestamp: registrations, cancellations and attendance marking do not make an event appear in an updatedSince result. To track attendance state, read attendeeCount on the list or use GET /events/user/ref/{ref} per user.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List users

Search users and return basic user information.

Inputs

Pagepagenumber
Used in combination with the limit parameter to page through the data.
Per pageper_pagenumber
Used in combination with the page parameter to page through the data.From 1 to 1000.
Updated sinceupdated_sincedate and time
Return only items updated on or after this date/time (ISO 8601).
Expandexpandtext
Comma-separated list of extra data to nest into the response. Omit it and the response is unchanged. - permissions - every permission domain currently supported, today audiences and spaces. New domains are added to this token over time. - audiencePermissions - audience management permissions only. - spacePermissions - space permissions only. When any permission domain is expanded the maximum perPage is reduced from 1000 to 100.
Statusesstatusestext
Only return users whose status is in this list. Comma-separated string. Allowed values (any combination): active, inactive, expired, new.
Omit statusesomit_statusestext
Exclude users whose status is in this list. Comma-separated string. Allowed values (any combination): active, inactive, expired, new.
Rolesrolestext
Only return users whose role is in this list. Comma-separated string. Allowed values (any combination): administrator, learneradmin, learner.
Omit rolesomit_rolestext
Exclude users whose role is in this list. Comma-separated string. Allowed values (any combination): administrator, learneradmin, learner.
Statusstatustext
Filter by a single user status. One value only (not comma-separated). Allowed values: active, inactive, expired, new.One of: active, inactive, expired, new.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "pageNumber": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List webhook events

Query stored outbound webhook events.

Inputs

Pagepagenumber
Page number for paginationAt least 1.
Per pageper_pagenumber
Number of records per pageFrom 1 to 1000.
Event typeevent_typetext
Filter by mapped webhook event type (e.g. content.completed, post.posted). See the full list at https://docs.thrivelearning.com/apidocs/webhooks
Subscription keysubscription_keytext
Filter by tenant subscription config key. See the available subscriptions at https://docs.thrivelearning.com/apidocs/webhooks
Delivery statusdelivery_statustext
Filter by webhook delivery outcomeOne of: delivered, failed.
Created fromcreated_fromdate and time
Return events ingested at or after this ISO 8601 timestamp. Defaults to 24 hours ago when omitted.
Created tocreated_todate and time
Return events ingested at or before this ISO 8601 timestamp.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "pagination": {
      "page": 1,
      "pageNumber": 1,
      "perPage": 20,
      "totalPages": 3,
      "totalResults": 48
    },
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Publish content

Publish a content record.

Inputs

IdidtextRequired
Unique identifier of the content item
Author refauthor_reftextRequired
Your organisation's reference for the acting user. The user is recorded as the publisher. The user must be active. A new, suspended, expired or deleted user is rejected.
Skillsskillslist
The complete list of skills to publish with. Sending this field replaces the skills the content was created with and keeps its topics; omitting it keeps both. Each name must be an existing skill in your organisation, or the request is rejected with 422. An empty list publishes with no skills.
Topicstopicslist
The complete list of topics to publish with. Sending this field replaces the topics the content was created with and keeps its skills; omitting it keeps both. Free names; a topic is not checked against your organisation's tags. An empty list publishes with no topics. A name cannot appear in both lists.
Published atpublished_atdate and time
The publish date to record, for content that was originally published elsewhere. ISO-8601, not in the future. Applied by a second write after the publish; see the endpoint description for the failure mode. Defaults to the time of the call.

Outputs

Value.

dataobject
The publish form of `ContentTransitionResponse`. Both the full and the minimal shape carry `publishedAtApplied` when the request sent `publishedAt`.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "publishedAtApplied": true
  },
  "has_more": false,
  "next_cursor": null
}

Reactivate user

Reactivate a suspended user.

Inputs

RefreftextRequired
The user ref

Outputs

Value.

dataobject
A user lifecycle resource returned by the v2 user lifecycle endpoints
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active": true,
    "additionalFields": {},
    "createdAt": "2021-08-18T13:48:00+00:00",
    "domain": "tenant.learn.link",
    "email": "user@thrivelearning.com",
    "endDate": "2021-06-11T16:00:00Z",
    "firstName": "Thomas",
    "id": "6143eedfd39243e830bdbb8c",
    "jobTitle": "Director",
    "languageCode": "en-gb",
    "lastName": "Jefferson",
    "loginMethod": "email",
    "managerRef": "UID0034234555",
    "ref": "UID30084022",
    "role": "learner",
    "sso": true,
    "startDate": "2021-01-01T09:00:00+00:00",
    "timeZone": "Europe/London",
    "updatedAt": "2021-08-19T18:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

Remove audience member

Removes an audience member.

Inputs

Audienceaudience_idtextRequired
Filter by audienceId or audience reference.
User refuser_reftextRequired
Filter by user

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Suspend user

Suspend a user.

Inputs

RefreftextRequired
The user ref
End dateend_datedate and time
The date this individual left your organisation

Outputs

Value.

dataobject
A user lifecycle resource returned by the v2 user lifecycle endpoints
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active": true,
    "additionalFields": {},
    "createdAt": "2021-08-18T13:48:00+00:00",
    "domain": "tenant.learn.link",
    "email": "user@thrivelearning.com",
    "endDate": "2021-06-11T16:00:00Z",
    "firstName": "Thomas",
    "id": "6143eedfd39243e830bdbb8c",
    "jobTitle": "Director",
    "languageCode": "en-gb",
    "lastName": "Jefferson",
    "loginMethod": "email",
    "managerRef": "UID0034234555",
    "ref": "UID30084022",
    "role": "learner",
    "sso": true,
    "startDate": "2021-01-01T09:00:00+00:00",
    "timeZone": "Europe/London",
    "updatedAt": "2021-08-19T18:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

Update content

Update a content record.

Inputs

IdidtextRequired
Unique identifier of the content item
Titletitletext
Title for this request.
Author refauthor_reftextRequired
Your organisation's reference for the acting user. The update is recorded against this user. A suspended or deleted user is rejected.
Can commentcan_commenttrue/false
Whether learners may comment on this content.
Is officialis_officialtrue/false
Whether the content is endorsed by your organisation. false leaves a stored CPD category as it is; send cpdCategoryId: null to clear it.
Cpd category IDcpd_category_idtext
The CPD category to record this content against. null clears it. An id is only accepted when the content is endorsed after the update (400 otherwise), and it must exist in your organisation (422 otherwise).
Primary categoryprimary_categorytext
The content type category a caller can set on mixed content, as the platform shows it on content cards and filters search on it. standard is displayed as "Mixed". A token outside this list is rejected with 422; event, pathway and question exist on the platform for legacy search filtering only and cannot be set here. The value is case insensitive and is stored in lower case. Omitted on create, a default is inferred: elearning when the content holds an e-learning item, otherwise standard. Omitted on update, the stored category is unchanged: an update never re-infers elearning, so content that gains its first e-learning item after create keeps standard until an update sets the category. The category cannot be cleared: null is rejected with 422. Set it on create or with PATCH /contents/{id}; the publish endpoint does not take it.One of: file, article, elearning, url, quiz, assessment, video, standard.
Completion typecompletion_typetext
How the content is completed.One of: auto, confirm, external, on_passing_quizzes, on_passing_observer_completed_quizzes, on_passing_assessments, on_elearning_completion, on_completing_interactive, on_clicking_links.
Increment versionincrement_versiontrue/false
Bump the content's version number. Valid only on published content (409 otherwise). This is not a snapshot , content keeps no version history, so any item replaced in this request has its previous file deleted permanently.
Add itemsadd_itemslist
Items to append. The per-request cap applies to this array only, not to the resulting document: at most one upload item plus one non-upload item. Each rank must be unique within this array (422 otherwise) and must not collide with the rank of an item already on the content (409 otherwise).
Update itemsupdate_itemslist
Existing items to change, identified by their item id. The type must match the stored item , an item cannot change type. Fields the change does not name keep their stored values. A rank that collides with the rank of another item that survives this request answers 409, the same as an added item's rank , ranks are checked as a set once the whole change is applied.
Remove itemsremove_itemslist
The ids of items to delete. Removing an upload item deletes its stored file permanently. An id that does not match an item on this content is rejected with 422.
Thumbnailthumbnailobject
Asks for a thumbnail upload URL. The content thumbnail is uploaded like an item file: give the upload a UUID here and PUT the image bytes (JPEG, PNG, GIF or WebP) to the signedPutUrls entry that echoes it. The uploadId is not stored; it only pairs this request with its response entry, so it must differ from every item uploadId in the same request (400 otherwise). A content has one thumbnail, and a later upload replaces it. Processing is asynchronous: the thumbnail counts for readiness once the image has been resized and stored.

Outputs

Value.

dataobject
The updated content with its presigned upload URLs. In the rare case that the content was updated but could not be read back, the response is the minimal form: `id`, `status` and `signedPutUrls` only. The update was applied in both cases , do not retry the request. A full body also satisfies the minimal shape, so this is `anyOf`.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Update user

Update a user.

Inputs

RefreftextRequired
The user ref
First namefirst_nametext
The given name of the individual
Last namelast_nametext
The family name of the individual
Emailemailtext
The email address for the user
Login methodlogin_methodtext
How the user logs in
Roleroletext
The role assigned to this individualOne of: administrator, learneradmin, learner.
Job titlejob_titletext
The name of this individual's role in your organisation
Manager refmanager_reftext
Your organisation's unique identifier for this individual's line manager
Start datestart_datedate and time
The date this individual started working with your organisation
End dateend_datedate and time
The date this individual left your organisation
Time zonetime_zonetext
The user's preferred timezone
Language codelanguage_codetext
The user’s preferred language. If not provided the tenant default is used. One caveat is that the tenant may only use the languages they have requested.One of: cs, de, en-gb, en-us, es, es-mx, fi, fr, hu, id, and 13 more.
Ssossotrue/false
Whether this account is managed by an Authentication provider or not.
Domaindomaintext
The domain this individual is associated with
Additional fieldsadditional_fieldsobject
Custom field key-value pairs matching your configured custom fields.

Outputs

Value.

dataobject
A user lifecycle resource returned by the v2 user lifecycle endpoints
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active": true,
    "additionalFields": {},
    "createdAt": "2021-08-18T13:48:00+00:00",
    "domain": "tenant.learn.link",
    "email": "user@thrivelearning.com",
    "endDate": "2021-06-11T16:00:00Z",
    "firstName": "Thomas",
    "id": "6143eedfd39243e830bdbb8c",
    "jobTitle": "Director",
    "languageCode": "en-gb",
    "lastName": "Jefferson",
    "loginMethod": "email",
    "managerRef": "UID0034234555",
    "ref": "UID30084022",
    "role": "learner",
    "sso": true,
    "startDate": "2021-01-01T09:00:00+00:00",
    "timeZone": "Europe/London",
    "updatedAt": "2021-08-19T18:00:00Z"
  },
  "has_more": false,
  "next_cursor": null
}

On this page