Sign in
Users

Get information about a user by ID

Returns information about the user with the given user_id. Requires admin, advocate, the same user ID as the API owner, or the access_user_info permission.

get/api/user/{user_id}

Response

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").

Changes