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 endpoint requires authentication via a write token or API credentials.

This method supports pagination using the limit and offset parameters. 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.

Parameters

---

query optional

A search query to filter the list of users.

---

limit optional

The number of records to return. Defaults to 10.

---

offset optional

The number of records to skip. Defaults to 0.

Returns

---

Returns a paginated list of referrals. Returns an error if an invalid tenant_alias is provided.

Example request

---

cURL

curl 'https://app.referralsaasquatch.com/api/v1/<tenant_alias>/[email protected]' \
  -X GET \
  -u ':<AccountSID>' \
  -H 'Accept: application/json'

Example response

---

JSON

{
  "count": 1,
  "totalCount": 1,
  "users": [
    {
      "id": "14125",
      "accountId": "89842",
      "email": "[email protected]",
      "firstName": "Mark",
      "lastName": "Testerson",
      "referralCode": "MARKTESTER",
      "imageUrl": "",
      "dateCreated": 1414452680584,
      "emailHash": "a65a76ba72e5a0b1e6253efce357abb6"
    }
  ]
}