Retrieve users

Authorization token

Media type indicating that the content is in JSON format.

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

The user's contact phone number.

An optional text field for storing additional information or notes about the user.

The unique login identifier for the user.

The user's given name.

The user's family or surname.

The user's email address.

The ID of the Source Group associated with the user.

The default page the user is directed to upon login. Options include Dashboard, ProfileSearch, and DataExport.

A numeric code representing the type or category of the landing page.

Determines if a new user is an SSO user in which a complete user registration email will not be sent if this value is true. NOTE: This property is currently only used for the creation of users and will not reflect an SSO status of an existing user nor change an existing user.

Indicates whether the user account is currently active (true) or deactivated (false).