Users

Get user details by email.

Retrieve the current status of any user's account by email.

[!important] The email parameter should be URL Encoded.

get/users/{email}

Request

Base URL
https://api.enterprise.airtm.com/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/docs/users/:email/get.ts
A function with typed inputs. Its response is checked against the schema.

emailstring required

The email of the user to retrieve

idstring uuid required

status'active' | 'inactive' required

Whether the user is active or inactive in Airtm

primaryEmailboolean required

Indicates if the queried email corresponds to the user's primary email

[!tip] Airtm allows accounts to register secondary emails

firstNamestring

The user's first name as registered in Airtm

lastNamestring

The user's last name as registered in Airtm

countrystring

The ISO alpha-3 code for the country where the user's ID was issued

isVerifiedboolean required

Indicates whether the user is verified

No recorded changes to this operation across all 1 revision of this API.