TalentLMS offers a range of API endpoints and resources designed to integrate TalentLMS with your internal systems seamlessly. It is organized around Representational State Transfer (REST) and is built to leverage standard HTTP features such as HTTP authentication and HTTP response codes, ensuring seamless integration. All API responses, including error messages, are consistently formatted in JSON for easy parsing and handling.
\nIf your TalentLMS domain is called βsamplesβ, then the API endpoint for your domain is https://samples.talentlms.com/api/v2.
The current version of the API consumes data β information about users, courses, categories, groups, branches, and general details about your domain. Apart from that, via the API you can log in / sign up a user in your domain, enroll a user in a course, and much more. Please make sure, that you are accessing the URLs below, under HTTPs connections, otherwise, you will receive an error.
\nTo start using the TalentLMS API, you must first enable the API and generate a valid API key from the portal's settings (Account & Settings > Integrations > API).
\nKeep in mind:
\nThe pagination limit of each request is 100.
\nThe API has rate and usage limits (e.g. 2000 requests per hour).
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key (All calls must have an Accept: application/json header value).
\nAll of the requests require authentication. Our API uses the API Key authorization method, with key X-API-Key and value your_api_key. You can always fill these fields in the global variables or create an environment and insert them there.
You will receive an HTTP 401 Unauthorized response code if the API key is missing, incorrectly formatted, or invalid.
\nTalentLMS API uses HTTP response codes to indicate the success or failure of requests. Specifically, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided arguments (e.g. instead of an integer a string is supplied), and the 500 error code indicates an internal TalentLMS error. Please be aware that you will receive an error too, in case you try to access an endpoint via non HTTPs connection.
\nAll errors return JSON consisting of a type (invalid_request_error or api_error) and a message describing the error.
\nRate limits represent the maximum number of API requests that are permitted to be made\nper hour. These limits depend on your subscription plan and are as follows:
\nRegardless of the total API requests per hour provisioned per customer, each customer's API requests should not exceed the rate of 200 API calls per 5 seconds. The following headers are included in API responses to help manage rate limits:
\nX-RateLimit-Limit: The maximum number of requests allowed in the current time window
X-RateLimit-Remaining: The number of requests left in the current window before hitting the limit
Our API supports pagination, splitting responses into size-customizable chunks of up to 100 items per request. You can navigate to the first, last, previous, or next page. The endpoints that support pagination return a list formatted as shown below:
\n{\n \"self\": \"https://example.talentlms.com/api/v2/users?page[number]=1&page[size]=10\",\n \"first\": \"https://example.talentlms.com/api/v2/users?page[number]=1&page[size]=10\",\n \"last\": \"https://example.talentlms.com/api/v2/users?page[number]=4&page[size]=10\",\n \"prev\": \"https://example.talentlms.com/api/v2/users?page[number]=1&page[size]=10\",\n \"next\": \"https://example.talentlms.com/api/v2/users?page[number]=2&page[size]=10\"\n}\n\nReturns a paginated list of users. Supports filtering by keyword, status, login, email, last_updated, branch_id, group_id, integration, and custom_field_value.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7cdd0a32-3fd6-4bd8-93cd-dd09e316ca86","id":"7cdd0a32-3fd6-4bd8-93cd-dd09e316ca86","name":"TalentLMS Public API","type":"collection"}},"urlObject":{"path":["api","v2","users"],"host":["https://your-domain.talentlms.com"],"query":[{"description":{"content":"Filter by user status
\n","type":"text/plain"},"key":"filter[status][eq]","value":"inactive"},{"description":{"content":"Filter by exact login match
\n","type":"text/plain"},"key":"filter[login][eq]","value":"Filter by exact email match
\n","type":"text/plain"},"key":"filter[email][eq]","value":"Search across name, surname, login, and email
\n","type":"text/plain"},"key":"filter[keyword][like]","value":"Filter users updated on or after this date (ISO 8601)
\n","type":"text/plain"},"key":"filter[last_updated][gte]","value":"Filter users updated on or before this date (ISO 8601)
\n","type":"text/plain"},"key":"filter[last_updated][lte]","value":"Filter users belonging to a specific branch
\n","type":"text/plain"},"key":"filter[branch_id][eq]","value":"Filter users belonging to a specific group
\n","type":"text/plain"},"key":"filter[group_id][eq]","value":"Filter users linked to a specific integration
\n","type":"text/plain"},"key":"filter[integration][eq]","value":"Filter users by a custom field value
\n","type":"text/plain"},"key":"filter[custom_field_value][eq]","value":"Page number (1-based)
\n","type":"text/plain"},"key":"page[number]","value":"Page size (maximum 100)
\n","type":"text/plain"},"key":"page[size]","value":"Sort field. Allowed: name, surname, login, email, type, registration, last_login, status, last_updated. Prefix with - for descending.
\n","type":"text/plain"},"key":"sort","value":"This endpoint accepts a JSON body containing the properties of the user to be created (e.g., name, email, password, etc.). Validates all required fields and returns the newly created user object upon success.
Retrieves the complete profile details of a specific user. To successfully fetch a user, include the user's unique ID as a path parameter in the request URL. If the request is valid and the user exists, the API returns the full set of user details in the response. Optionally include related resources via the resources query parameter.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"7cdd0a32-3fd6-4bd8-93cd-dd09e316ca86","id":"7cdd0a32-3fd6-4bd8-93cd-dd09e316ca86","name":"TalentLMS Public API","type":"collection"}},"urlObject":{"path":["api","v2","users",":id"],"host":["https://your-domain.talentlms.com"],"query":[{"description":{"content":"Optional related resources to include in the response. Accepts a single value or a comma-separated list. Allowed values: branches, groups, courses, certificates, all (expands to all four).
\n","type":"text/plain"},"key":"resources","value":"(Required) The ID of the user
\n","type":"text/plain"},"type":"any","value":"