HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

User Overview

Users are the participants in your program, such as your customer advocates and their referred friends. In other places, a User might also be called a Contact, Lead or Participant. Users are each mapped to one specific account.

The following information is controlled at the user level:

  • First and last name
  • Email address
  • Referral code
  • Share links
  • Custom fields
Endpoints
GETLookup a user PII
POSTBlock user
POSTUnblock user
GETList users
PUThttps://app.referralsaasquatch.com/api/v1/`{tenant_alias}`/open/account/`{accountId}`/user/`{userId}`
POSThttps://app.referralsaasquatch.com/api/v1/`{tenant_alias}`/open/account/`{accountId}`/user/`{userId}`
GEThttps://app.referralsaasquatch.com/api/v1/`{tenant_alias}`/open/account/`{accountId}`/user/`{userId}`
DELETEDelete a user
GETGet a user by a referral code