API ReferenceUsers

List all users

Returns a list of users. Up to 100 users are returned per request.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional
The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
emailstringOptional

Filters the list of users based on the email field.

foreignIdstringOptional

The customer-specific unique identifier associated to an Abound record. Allows developers to forego making their own tables every time they integrate and/or add an 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