External DocumentationTo learn more, visit the Living Security documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Campaign ID | Filter results by the campaign’s ID. |
| Cursor | Pagination cursor returned from a previous request. If this value is provided, results continue from the last cursor and any other specified search attributes or terms will be ignored. |
| Filter results by the participant’s email address. | |
| Page | The page to show results from, defaults to 1. |
| Page Size | The maximum number of results to return, defaults to 20. |
| Requires Passing Grade | Select to include only assignments that require a passing grade. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort | Sort the returned assignments by their properties. The format of the sort criteria is: field|direction. Direction can be either asc (ascending) or desc (descending) order.Defaults to assigned_date|desc. When the direction is not specified, defaults to asc. |
| User ID | Filter results by the user ID. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Accuracy | Filter results by the assignment’s accuracy. |
| Assigned Date | Filter results by the date the assignment was assigned. |
| Completion Time | Filter results by the time taken to complete the assignment. |
| Content ID | Filter results by the assignment’s content ID. |
| Content Title | Filter results by the assignment’s content title. |
| Content Type | Filter results by the type of content in the assignment. |
| Progress | Filter results by the assignment’s progress. |
| Required | Select to include only required assignments. |
| Status | Filter results by the assignment’s status. |
| Total Questions Answered | Filter results by the total number of questions answered. |
| Total Questions Correct | Filter results by the total number of questions answered correctly. |
Example Output
{
"data": [
{
"id": "string",
"assigned_date": "2025-04-28T11:47:39.227Z",
"started_date": "2025-04-28T11:47:39.227Z",
"completion_date": "2025-04-28T11:47:39.227Z",
"due_date": "2025-04-28T11:47:39.227Z",
"status": "NOT_STARTED",
"progress": 0,
"accuracy": 0,
"completion_time": 0,
"content_title": "string",
"content_type": "string",
"content_id": "string",
"content_categories": [
"string"
],
"content_concepts": [
"string"
],
"campaign_id": "string",
"required": true,
"requires_passing_grade": true,
"total_questions_answered": 0,
"total_questions_correct": 0,
"email": "string",
"user_id": "string"
}
],
"meta": {
"total": 0,
"returned": 0,
"pagination": {
"page_size": 0,
"page": 0,
"next": "string"
}
}
}
Workflow Library Example
List Assignments with Living Security and Send Results Via Email