Sign in
Users

Get user

Changed on

Retrieve a user record.

<div> <code>read:users</code> </div>
get/api/v1/user

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/user
  • Auth: HTTP bearer

Query parameters

idstring required

The user's id.

expandstring nullable

Additional data to include in the response. One or more of (comma-separated): "organizations", "identities", "billing".

Response

User successfully retrieved.

idstring

Unique ID of the user in Kinde.

provided_idstring

External ID for user.

preferred_emailstring

Default email address of the user in Kinde.

phonestring

User's primary phone number.

usernamestring

Primary username of the user in Kinde.

last_namestring

User's last name.

first_namestring

User's first name.

is_suspendedboolean

Whether the user is currently suspended or not.

picturestring

User's profile picture URL.

total_sign_insinteger nullable

Total number of user sign ins.

failed_sign_insinteger nullable

Number of consecutive failed user sign ins.

last_signed_instring nullable

Last sign in date in ISO 8601 format.

created_onstring nullable

Date of user creation in ISO 8601 format.

organizationsstring[]

Array of organizations a user belongs to.

Changes