API ReferenceUsers

Retrieve a user

Retrieves the details of an existing user.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequired

The unique identifier for a single end-user of your application.

Response

OK
createdAtdatetime

The creation date and time of the user in ISO 8601 format.

idstring
The unique identifier for this user.
foreignIdstring or null

The customer-specific unique identifier associated with this user.

metadatamap from strings to strings or null

Use metadata for storing additional user data. For filtering, please use foreignId.

emailstring or nullformat: "email"Deprecated
The user's email address. Abound assume's you have taken the proper steps to verify the ownership of this email address.

Errors