List Users

Retrieve a list of all users, including accepted, invited, and Slack users.

External Documentation

To learn more, visit the Onyx documentation.

​

Parameters

Parameter	Description
Accepted Page	The page number of accepted users to retrieve.
Include API Keys	Select to include API key users in the results.
Invited Page	The page number of invited users to retrieve.
Query	The search query to filter users by.
Slack Users Page	The page number of Slack users to retrieve.

​

Example Output

{
	"accepted": [
		{
			"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
			"email": "<string>",
			"is_active": true,
			"password_configured": true
		}
	],
	"invited": [
		{
			"email": "<string>"
		}
	],
	"slack_users": [
		{
			"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
			"email": "<string>",
			"is_active": true,
			"password_configured": true
		}
	],
	"accepted_pages": 123,
	"invited_pages": 123,
	"slack_users_pages": 123
}