v1

latestOpenAPI 3.1.02026-08-067019120.8 KB

Users

Retrieve user information by username

Returns information about the user with the given e-mail address. Requires admin, advocate, or the access_user_info permission.

get/api/user_info

usernamestring email required

The e-mail address of the user.

case_sensitive0 | 1

Set to 1 for a case-sensitive e-mail lookup.

User information.

idinteger

Integer user ID.

emailstring email

first_namestring

last_namestring

countrystring

Country code (e.g. "US").

subdivisionfirststring

State.

subdivisionsecondstring

County.

subdivisionthirdstring

Municipality.

organizationstring

timezonestring

Time-zone string (e.g. "America/New_York").

languagestring

Language code (e.g. "en").

privilegesstring[]

List of privilege names the user holds.

activeboolean

Whether the user account is active.

account_typestring

Authentication provider type (e.g. "local").