LogoLogo
LoginGet Started
GuidesAPI ReferenceSDKs & Postman
GuidesAPI ReferenceSDKs & Postman
  • API Reference
LoginGet Started
API ReferenceUsers

Retrieve a user

GET
/v4/users/:userId
GET
/v4/users/:userId
1curl https://sandbox-api.withabound.com/v4/users/userId_sampleXGMFnhOpeR \
2     -H "Authorization: Bearer <apiKey>"
Try it
1{
2  "createdAt": "2024-01-01T00:00:00.000Z",
3  "id": "userId_sampleXGMFnhOpeR",
4  "foreignId": "my-foreign-id"
5}
Retrieves the details of an existing user.

Path parameters

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

Headers

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

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

Was this page helpful?
Previous

Update a user

Next
Built with
OK

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

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

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