HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

List users

List all of the Users in your Advocate referral programs. This method is the primary way of getting a full list of everyone that has been identified through the API, UTT, or mobile widgets.

This method supports pagination using the parameters for limit and offset to iterate through a very large list of records.

You can also search for particular users using the query method. To find information about which users have completed referrals, use the List referrals method.

Path Params
string
required

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Query Params
string

A search query that can be used to filter users by email, name or ID.

integer
Defaults to 10

A limit on the number of results returned. Defaults to 10.

integer
Defaults to 0

When included offsets the first result returns in the list. Use this to paginate through a long list of results. Defaults to 0

Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json