List Users

List users.

Basic Parameters

Parameter	Description
Return All Pages	Automatically fetch all resources, page by page.
Search	String to search on.

Advanced Parameters

Parameter	Description
Company ID	The identifier for the company to which the user belongs to filter by.
Country	The country associated with the user to filter by.
Department ID	The identifier for the department to which the user belongs to filter by.
Email	The user’s email address to filter by.
Employee Num	The user’s employee number to filter by.
First Name	The user’s first name to filter by.
Group ID	The identifier for the group to which the user belongs to filter by.
Last Name	The user’s last name to filter by.
Limit	Number of records to return.
Location ID	The identifier for the location associated with the user to filter by.
Offset	Offset to use when retrieving results (useful in pagination).
Order	Sort order (asc or desc).
Sort	Field to order by.
State	The state associated with the user to filter by.
User Name	The user’s chosen username to filter by.
Zip	The ZIP or postal code associated with the user to filter by.

Example Output

{
	"total": 52,
	"rows": [
		{
			"id": 131,
			"avatar": "<string>",
			"name": "<string>",
			"first_name": "<string>",
			"last_name": "<string>",
			"username": "<string>",
			"remote": false,
			"locale": "<string>",
			"employee_num": null,
			"manager": null,
			"jobtitle": "<string>",
			"vip": false,
			"phone": null,
			"website": null,
			"address": null,
			"city": "<string>",
			"state": null,
			"country": null,
			"zip": null,
			"email": "<string>",
			"department": null,
			"location": null,
			"notes": "<string>",
			"permissions": null,
			"activated": false,
			"autoassign_licenses": true,
			"ldap_import": false,
			"two_factor_enrolled": false,
			"two_factor_optin": false,
			"assets_count": 2,
			"licenses_count": 1,
			"accessories_count": 2,
			"consumables_count": 1,
			"manages_users_count": 1,
			"manages_locations_count": 1,
			"company": null,
			"created_by": {
				"id": 1,
				"name": "<string>"
			},
			"created_at": {
				"datetime": "2025-04-01 01:10:12",
				"formatted": "Tue Apr 01, 2025 1:10AM"
			},
			"updated_at": {
				"datetime": "2025-04-01 01:10:12",
				"formatted": "Tue Apr 01, 2025 1:10AM"
			},
			"start_date": null,
			"end_date": null,
			"last_login": null,
			"deleted_at": null,
			"available_actions": {
				"update": true,
				"delete": true,
				"clone": true,
				"restore": false
			},
			"groups": null
		},
		{
			"id": 1,
			"avatar": "<string>",
			"name": "<string>",
			"first_name": "<string>",
			"last_name": "<string>",
			"username": "<string>",
			"remote": false,
			"locale": "<string>",
			"employee_num": "<string>",
			"manager": null,
			"jobtitle": "<string>",
			"vip": false,
			"phone": "<string>",
			"website": null,
			"address": "<string>",
			"city": "<string>",
			"state": "<string>",
			"country": "<string>",
			"zip": "<string>",
			"email": "<string>",
			"department": {
				"id": 6,
				"name": "<string>"
			},
			"location": null,
			"notes": "<string>",
			"permissions": {
				"superuser": "<string>"
			},
			"activated": true,
			"autoassign_licenses": true,
			"ldap_import": false,
			"two_factor_enrolled": false,
			"two_factor_optin": false,
			"assets_count": 12,
			"licenses_count": 2,
			"accessories_count": 2,
			"consumables_count": 0,
			"manages_users_count": 4,
			"manages_locations_count": 2,
			"company": {
				"id": 1,
				"name": "<string>"
			},
			"created_by": {
				"id": 2,
				"name": "<string>"
			},
			"created_at": {
				"datetime": "2025-04-01 01:10:12",
				"formatted": "Tue Apr 01, 2025 1:10AM"
			},
			"updated_at": {
				"datetime": "2025-04-01 01:10:12",
				"formatted": "Tue Apr 01, 2025 1:10AM"
			},
			"start_date": null,
			"end_date": null,
			"last_login": {
				"datetime": "2025-04-01 01:10:12",
				"formatted": "Tue Apr 01, 2025 1:10AM"
			},
			"deleted_at": null,
			"available_actions": {
				"update": true,
				"delete": false,
				"clone": true,
				"restore": false
			},
			"groups": null
		}
	]
}

Workflow Library Example

List Users with Snipe It and Send Results Via Email

Preview this Workflow on desktop