Skip to main content
Retrieve a list of your company’s users from the system.
External DocumentationTo learn more, visit the Alertmedia documentation.

​
Basic Parameters

ParameterDescription
EmailThe email of the user to filter by.
First NameThe first name of the user to filter by.
Last NameThe last name of the user to filter by.
OrderingThe field to sort by the users.
PhoneThe phone of the user to filter by (phone numbers in E.164 format).
User IDsA comma-separated list of user IDs to filter by.

​
Advanced Parameters

ParameterDescription
Customer User IDThe 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 IDsA comma-separated list of group IDs to filter by. Returns users in at least one of the specified groups.
Has DeviceSelect to get users who have a registered device.
Has EmailSelect to get users who have an email address.
Has Mobile PhoneSelect to get users who have a mobile phone number.
Has PhoneSelect to get users who have a phone number (home_phone, office_phone).
Not In Group IDsA comma-separated list of group IDs. Returns users not in the specified groups.
Notification IDThe ID of a specific notification. Returns users that have received that notification.

​
Example Output

[
	{
		"id": 1,
		"first_name": "Test",
		"last_name": "One",
		"email": "[email protected]",
		"mobile_phone": "+15551234567"
	},
	{
		"id": 2,
		"first_name": "Test",
		"last_name": "Two",
		"email": "[email protected]",
		"mobile_phone": "+15559876543"
	}
]

​
Workflow Library Example

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