SaaSquatch Help Center

The SaaSquatch APIs authenticate requests using API Keys to ensure secure data transmission.

All interactions with the SaaSquatch API use an API key for authentication.

🔗 Access API key

Access the API key of either your Live and Test tenant.

  1. Head to your SaaSquatch account.
  2. In the upper right corner of your SaaSquatch account select either your Live or Test tenant.
  3. Click "Settings" from the Header
  4. Select "Install" tab to view the Tenant details including the API key.
  5. Click "Reveal" to display the API key.

Note: Authentication to the API occurs via HTTP Basic Auth. Provide your API key as the basic auth password. You do not need to provide a username.

Do not expose any API keys to unauthorized users, such as through code of a client-side page.

🔗 Reset API Key

If an API key has been compromised, It can be reset to ensure secure exchanges of data.

  1. Head to your SaaSquatch account.
  2. In the upper right corner of your SaaSquatch account select either your Live or Test tenant.
  3. Click "Settings" from the Header
  4. Select "Install" tab to view the Tenant details including the API key.
  5. Click "Reset" under the API Key section.
  6. Select "Regenerate Key" to confirm creation of a new API key.
  7. A new API key is now available for the Tenant.

All API requests are made over HTTPS. Unsecured requests will fail.

🔗 Example:

curl -X POST https://app.referralsaasquatch.com/api/v1/{tenant_alias}/code/{code} \
-u :TEST_B4BYA15POHYQ284HBND1 \

curl uses the -u flag to pass basic auth credentials.