get https://api.kustomerapp.com/v1/users
Retrieves users within the organization.
Filtering
This endpoint supports optional filtering in one of the following ways:
Note: These filters cannot be combined.
Pending (invitation)
Add pending=(true|false)
in the query parameters with one of the following options:
true
- Return only disabled usersfalse
- Return only active users
Deleted (deactivated)
Add deleted=(true|false)
in the query parameters with one of the following options:
true
- Return only deactivated usersfalse
- Return only active users
User Type
Add userType=[userType]
in the query parameters with one of the following options:
user
- Full usermachine
- Machine user / API userlimited
- Collaborator user
Email
Add email=[email]
in the query parameter to filter for a specific user email address.