v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Training Content

Get Training Content [Single]

🚧 Partner Restricted All LMS API endpoints are restricted to LMS providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

The GET Training Content [Single] endpoint allows partners to retrieve details about specific content in a client media content library by content ID. By sending a GET request, users can access content metadata such as the content ID, title, description, URL, file ID, duration, and optional thumbnail URL. This API provides a way for partners to manage and review individual content items within their LMS integration.

Use Cases

  • An integration retrieves a single content record to confirm that metadata values match the partner’s source system before updates or version changes.
  • A reporting or analytics tool retrieves data to analyze the statistics on the total number of employees assigned to the training.
  • A reporting or analytics tool retrieves data to analyze the statistics on the total number of employees who completed the training.
  • A content provider retrieves a single item to determine whether it should be updated, replaced, or deprecated based on its current metadata.
get/apiHub/learningManagementSystem/v1/companies/{companyId}/contents/{contentId}

Path parameters

companyIdstring required

The Paylocity Company Identifier. Unique value provided by Paylocity. Allowable Values: 9 char max.

contentIdstring required

Unique GUID identifier of the training content item to retrieve.

Query parameters

includestring

Optional. To include usage statistics, pass usageStats. To include the content's state by pass 'contentState'. Possible statuses are 'success', 'pending upload', 'upload failed', and 'upload failed, invalid content length'.

Headers

testModeboolean

If true, responses are mocked and generated randomly.

Response

OK - Returns the requested training content details (test mode only).