Skip to main content
Retrieve a list of directory integration users.
External DocumentationTo learn more, visit the Kandji documentation.

​
Basic Parameters

ParameterDescription
ArchivedSelect to return only archived users.
EmailA comma-separated list of user email addresses to filter results by.
Integration UUIDThe UUID of the integration to filter results by.
Return All PagesAutomatically fetch all resources, page by page.
User UUIDThe UUID of the user to filter results by.

​
Advanced Parameters

ParameterDescription
CursorThe cursor used to paginate through the results. Use the value returned in the next attribute from a prior response to retrieve the next page.

​
Example Output

{
	"next": "https://accuhive.kandji.io/api/v1/users?cursor=cD0yOTE0Mw%3D%3D",
	"previous": null,
	"results": [
		{
			"active": true,
			"archived": false,
			"created_at": "2024-09-06T21:00:04.304248Z",
			"department": null,
			"deprecated_user_id": "29360",
			"email": "test_user_01@accuhive.io",
			"id": "69c009ca-1f78-4bdf-bb93-08d6d39041db",
			"integration": {
				"id": 634,
				"name": "accuhive",
				"uuid": "f7461096-4ef9-43aa-88e9-ca1967ba0b38",
				"type": "office365"
			},
			"job_title": null,
			"name": "test_user_01",
			"device_count": 2,
			"updated_at": "2024-09-06T21:00:04.304280Z"
		}
	]
}

​
Workflow Library Example

List Users with Kandji and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop