Retrieve a list of assigned training courses for users and the assignment status.

​
Basic Parameters

ParameterDescription
Filter OptionsChoose whether to build a custom query or use the query builder.

Note:

The query builder does not support filtering by more than one filter parameter per field type, nor does it support logical operations.

Building a custom query allows distinguishing between two or more filters of the same field type. For example:

field[<field_name>]&field[<field_name>;1]&op[<op_name>]&op[<op_name>;1]
FiltersFilters to apply to search. For example:

* Retrieve course assignments for the user with the username equal to jane.doe.
field[username]=jane.doe&op[username]=eq

* Retrieve course assignments for users with a last name starting with smith.
field[last_name]=smith&op[last_name]=sw

* Retrieve course assignments created in 2024 for a user ID equal to 4567890 sorted by due date.
field[assignment_date]=2024-01-01&op[assignment_date]=gte&field[assignment_date;1]=2025-01-01&op[assignment_date;1]=lt&field[user_id]=4567890&sort=due_date
OrderThe sort order direction. Defaults to Ascending.
PageThe page number to return results from. Defaults to 1.
Per PageThe maximum number of assignments to return per request. Defaults to 100.
SortThe field to sort the assignment records by. Defaults to Assignment Date.

​
Advanced Parameters

ParameterDescription
Assignment DateFilter by assignment date.
Assignment Date OperatorThe operator to use for filtering by Assignment Date. Defaults to Greater Than or Equals.
Completed DateFilter by completed date.
Completed Date OperatorThe operator to use for filtering by Completed Date. Defaults to Greater Than or Equals.
CountryFilter by an ISO 31661 alpha-2 two letter country code.
Country OperatorThe operator to use for filtering by Country. Defaults to Contains.
Course IDFilter by course ID.
Course ID OperatorThe operator to use for filtering by Course ID. Defaults to Equals.
Course NameFilter by course name.
Course Name OperatorThe operator to use for filtering by Course Name. Defaults to Contains.
Department IDFilter by department ID.
Department ID OperatorThe operator to use for filtering by Department ID. Defaults to Equals.
Department NameFilter by department name.
Department Name OperatorThe operator to use for filtering by Department Name. Defaults to Contains.
Due DateFilter by due date.
Due Date OperatorThe operator to use for filtering by Due Date. Defaults to Greater Than or Equals.
ElectiveFilter by elective status.
Elective OperatorThe operator to use for filtering by Elective. Defaults to Equals.
EmailFilter by email address.
Email OperatorThe operator to use for filtering by Email. Defaults to Contains.
First NameFilter by first name.
First Name OperatorThe operator to use for filtering by First Name. Defaults to Contains.
IDFilter by ID.
ID NumberFilter by ID Number.
ID Number OperatorThe operator to use for filtering by ID Number. Defaults to Contains.
ID OperatorThe operator to use for filtering by ID. Defaults to Equals.
Last Access DateFilter by last access date.
Last Access Date OperatorThe operator to use for filtering by Last Access Date. Defaults to Greater Than or Equals.
Last NameFilter by last name.
Last Name OperatorThe operator to use for filtering by Last Name. Defaults to Contains.
LocationFilter by location.
Location OperatorThe operator to use for filtering by Location. Defaults to Contains.
PhoneFilter by phone number.
Phone OperatorThe operator to use for filtering by Phone. Defaults to Contains.
RoleFilter by role.
Role OperatorThe operator to use for filtering by Role. Defaults to Equals.
ScoreFilter by score.
Score OperatorThe operator to use for filtering by Score. Defaults to Greater Than or Equals.
Start DateFilter by start date.
Start Date OperatorThe operator to use for filtering by Start Date. Defaults to Greater Than or Equals.
StateFilter by a two letter United States state abbreviation.
State OperatorThe operator to use for filtering by State. Defaults to Contains.
SuspendedFilter by suspended status.
Suspended OperatorThe operator to use for filtering by Suspended. Defaults to Equals.
TitleFilter by the user’s job title.
Title OperatorThe operator to use for filtering by Title. Defaults to Contains.
User IDFilter by user ID.
User ID OperatorThe operator to use for filtering by User ID. Defaults to Equals.
UsernameFilter by username.
Username OperatorThe operator to use for filtering by Username. Defaults to Contains.

​
Example Output

{
	"data": [
		{
			"id": 123,
			"assignment_date": "2024-09-14T00:18:03.000000Z",
			"elective": false,
			"due_date": "2024-11-13T04:59:59.000000Z",
			"start_date": null,
			"last_access_date": null,
			"time_spent": "",
			"completed_date": null,
			"score": null,
			"certificate_visible": false,
			"user": {
				"id": 379,
				"username": "sally@company.tld",
				"first_name": "Sally",
				"last_name": "Student",
				"phone": "+1 555-555-9870",
				"email": "sally@company.tld",
				"role": "Student",
				"suspended": false,
				"id_number": "2-105",
				"title": "Sales Manager",
				"state": "CA",
				"country": "US",
				"location": "South Office",
				"hire_date": null,
				"create_date": "2024-09-11T19:26:09.000000Z",
				"modified_date": "2024-09-14T00:14:57.000000Z",
				"last_login_date": null
			},
			"department": {
				"id": 96,
				"name": "Sales"
			},
			"course": {
				"id": 19,
				"short_name": "PDHE_51_Office_US_eng_std_071723",
				"display_name": "Preventing Discrimination & Harassment",
				"sku": null
			}
		}
	],
	"links": {
		"first": "http://localhost/api/v3/assignments?page=1",
		"last": "http://localhost/api/v3/assignments?page=10",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 10,
		"path": "http://localhost/api/v3/assignments",
		"per_page": 100,
		"to": 10,
		"total": 960
	}
}

​
Workflow Library Example

List Assignments with Traliant Lms and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop