Skip to main content
Retrieve a list of tasks with optional filtering.
External DocumentationTo learn more, visit the Check Point Management documentation.

​
Parameters

ParameterDescription
Details LevelThe level of details to include in the response.
From DateThe starting date to retrieves tasks from.
InitiatorThe name of the user who initiated the tasks. If not specified, tasks initiated by all users are returned.
LimitThe maximum number of results to return in the response.

Valid range is - 1 to 500.
OffsetThe pagination offset indicating the starting point for the next set of results.
OrderA JSON list of fields and their sorting order.

Example:
[
  { “name”: “ASC” },
  { “createdAt”: “DESC” }
]
Return All PagesAutomatically fetch all resources, page by page.
StatusThe status of the tasks to retrieve.
To DateThe ending date to retrieves tasks from.

​
Example Output

{
	"from": 0,
	"to": 1,
	"total": 2,
	"tasks": [
		{
			"name": "daily-backup-task",
			"uid": "b7f4c2e1-91ad-4e73-a8c1-6b9e8f12d001",
			"type": "backup",
			"task-id": "task-001",
			"task-name": "Daily Backup",
			"status": "succeeded",
			"suppressed": false,
			"progress-description": "Backup completed successfully",
			"progress-percentage": 100,
			"revert-status": "succeeded",
			"start-time": {
				"iso-8601": "2025-12-30T09:00:00Z",
				"posix": 1767085200000
			},
			"last-update-time": {
				"iso-8601": "2025-12-30T09:05:12Z",
				"posix": 1767085512000
			},
			"task-details": [
				{
					"step": "snapshot",
					"result": "completed"
				},
				{
					"step": "upload",
					"result": "completed"
				}
			],
			"color": "dark green",
			"comments": "Executed as part of scheduled maintenance",
			"domain": {
				"name": "Primary-Domain",
				"uid": "domain-123",
				"domain-type": "global domain",
				"icon": "globe"
			},
			"meta-info": {
				"creation-time": {
					"iso-8601": "2025-12-01T08:00:00Z",
					"posix": 1764576000000
				},
				"creator": "admin",
				"last-modifier": "system",
				"last-modify-time": {
					"iso-8601": "2025-12-30T09:05:12Z",
					"posix": 1767085512000
				},
				"lock": "unlocked",
				"validation-state": "ok"
			},
			"read-only": false,
			"tags": [
				{
					"name": "backup",
					"uid": "tag-001",
					"type": "system",
					"color": "blue",
					"domain": {
						"name": "Primary-Domain",
						"uid": "domain-123",
						"domain-type": "global domain",
						"icon": "globe"
					}
				}
			],
			"available-actions": {
				"clone": "true",
				"delete": "false",
				"edit": "true"
			}
		},
		{
			"name": "weekly-report-task",
			"uid": "e92a3a7d-4f0c-45d4-9a4a-4bcd9912f002",
			"type": "report",
			"task-id": "task-002",
			"task-name": "Weekly Report",
			"status": "in progress",
			"suppressed": false,
			"progress-description": "Generating report",
			"progress-percentage": 45,
			"revert-status": "in_progress",
			"start-time": {
				"iso-8601": "2025-12-30T10:00:00Z",
				"posix": 1767088800000
			},
			"last-update-time": {
				"iso-8601": "2025-12-30T10:03:30Z",
				"posix": 1767089010000
			},
			"task-details": [
				{
					"step": "collect-data",
					"result": "completed"
				},
				{
					"step": "generate-report",
					"result": "running"
				}
			],
			"color": "orange",
			"comments": "May take several minutes",
			"domain": {
				"name": "Analytics-Domain",
				"uid": "domain-456",
				"domain-type": "data domain",
				"icon": "chart"
			},
			"meta-info": {
				"creation-time": {
					"iso-8601": "2025-12-15T12:30:00Z",
					"posix": 1765801800000
				},
				"creator": "analytics-admin",
				"last-modifier": "analytics-admin",
				"last-modify-time": {
					"iso-8601": "2025-12-30T10:03:30Z",
					"posix": 1767089010000
				},
				"lock": "locked by current session",
				"validation-state": "info"
			},
			"read-only": false,
			"tags": [
				{
					"name": "reporting",
					"uid": "tag-002",
					"type": "user",
					"color": "gold",
					"domain": {
						"name": "Analytics-Domain",
						"uid": "domain-456",
						"domain-type": "data domain",
						"icon": "chart"
					}
				}
			],
			"available-actions": {
				"clone": "not_supported",
				"delete": "true",
				"edit": "false"
			}
		}
	]
}

​
Workflow Library Example

Show Tasks with Check Point Management and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop