Skip to main content
Get a list of campaigns with optional filtering.
External DocumentationTo learn more, visit the Living Security documentation.

​
Parameters

ParameterDescription
Audience TypeFilter results by the campaign’s audience type.
Campaign IDFilter results by the campaign’s ID.
CursorPagination 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.
NameFilter results by the campaign’s name.
PageThe page to show results from, defaults to 1.
Page SizeThe maximum number of results to return, defaults to 20.
Return All PagesAutomatically fetch all resources, page by page.
SortSort the returned campaigns by their properties.

The format of the sort criteria is: field|direction. Direction can be either asc (ascending) or desc (descending) order.

Defaults to campaign_id|asc. When the direction is not specified, defaults to asc.
StateFilter results by the campaign’s state.

​
Example Output

{
	"data": [
		{
			"campaign_id": "string",
			"accuracy": 0,
			"campaign": {
				"name": "string",
				"description": "string",
				"test": true,
				"created": "2025-04-28T11:47:39.227Z",
				"date_end": "2025-04-28T11:47:39.227Z",
				"date_start": "2025-04-28T11:47:39.227Z",
				"participant_count": 0,
				"audience_type": "string",
				"audience_count": 0,
				"audiences": [
					{
						"participant_count": 0,
						"name": "string",
						"id": "string"
					}
				],
				"modified": "2025-04-28T11:47:39.227Z",
				"state": "string"
			},
			"assignments_completed": 0,
			"audience_count": 0,
			"average_completion_time": 0,
			"completion_rate": 0,
			"assignment_completion_rate": 0,
			"current_participant_count": 0,
			"delinquency_rate": 0,
			"overdue": 0,
			"not_started": 0,
			"underway": 0,
			"completed": 0,
			"total_assignments": 0,
			"total_questions_answered": 0,
			"total_questions_correct": 0
		}
	],
	"meta": {
		"total": 0,
		"returned": 0,
		"pagination": {
			"page_size": 0,
			"page": 0,
			"next": "string"
		}
	}
}

​
Workflow Library Example

List Campaigns with Living Security and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop