latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Users

Get a user by email

Retrieves a user matching the specified email address.

get/users/email={email}

Response

OK

idstring uuid required

The ID of the user.

deactivatedboolean required

Whether the user has been deactivated.

namespacestring required

The namespace in which the user's username is unique.

usernamestring required

The user's username.

emailstring email required

The user's email address.

email_verifiedboolean required

Whether the user's email address has been verified.

first_namestring required

The user's first name.

last_namestring required

The user's last name.

picturestring uri required

The user's picture.

companystring required

The user's company.

websitestring uri required

The user's website.

countrystring required

The user's ISO 3166-1 alpha-2 country code.

created_atstring date-time required

The date and time when the user was created.

updated_atstring date-time required

The date and time when the user was last updated.

consented_atstring date-time

The date and time when the user consented to the Terms of Service.

consent_method'opt-in' | 'text-ref'

The method by which the user consented to the Terms of Service.