List Users - BlinkOps Documentation

Retrieve a list of your company’s users from the system.

External DocumentationTo learn more, visit the Alertmedia documentation.

Basic Parameters

Parameter	Description
Email	The email of the user to filter by.
First Name	The first name of the user to filter by.
Last Name	The last name of the user to filter by.
Ordering	The field to sort by the users.
Phone	The phone of the user to filter by (phone numbers in E.164 format).
User IDs	A comma-separated list of user IDs to filter by.

Advanced Parameters

Parameter	Description
Customer User ID	The customer’s user ID from the internal system to filter by. Only applicable if you’ve populated users with `customer_user_id`. For more information, please refer to Filtering Users.
Group IDs	A comma-separated list of group IDs to filter by. Returns users in at least one of the specified groups.
Has Device	Select to get users who have a registered device.
Has Email	Select to get users who have an email address.
Has Mobile Phone	Select to get users who have a mobile phone number.
Has Phone	Select to get users who have a phone number (`home_phone`, `office_phone`).
Not In Group IDs	A comma-separated list of group IDs. Returns users not in the specified groups.
Notification ID	The ID of a specific notification. Returns users that have received that notification.

Example Output

[
	{
		"id": 1,
		"first_name": "Test",
		"last_name": "One",
		"email": "test.one@example.com",
		"mobile_phone": "+15551234567"
	},
	{
		"id": 2,
		"first_name": "Test",
		"last_name": "Two",
		"email": "test.two@example.com",
		"mobile_phone": "+15559876543"
	}
]