canonical: https://jentic.com/apis/saasquatch.com/saasquatch

# SaaSquatch API

SaaSquatch is a referral and loyalty platform API for managing users, accounts, referrals, rewards, webhooks, and exports. The API exposes 22 endpoints secured with basic authentication.

## For AI agents

Programmatically create or update an account, lookup an account. Covers 22 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Create or update an account
- Lookup an account
- Delete an account
- List users
- Monitor SaaSquatch API operational status and events

## Use cases

### Developer Tools Operations

Use the SaaSquatch API to perform developer tools operations programmatically. The API provides 22 endpoints covering core functionality including create or update an account, lookup an account, delete an account.

Example prompt: Call POST /{tenant_alias}/accountsync to create or update an account

### Automated Accounts Management

Automate accounts operations by combining multiple SaaSquatch API endpoints. Agents can lookup an account and then delete an account in a single workflow.

Example prompt: Call GET /{tenant_alias}/account/{accountId} to lookup an account, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SaaSquatch API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'create or update an account', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/{tenant_alias}/accountsync` | Create or update an account |
| GET | `/{tenant_alias}/account/{accountId}` | Lookup an account |
| DELETE | `/{tenant_alias}/open/account/{accountId}` | Delete an account |
| POST | `/{tenant_alias}/user` | Create or update a user |
| GET | `/{tenant_alias}/user` | Lookup a user by referral code |
| GET | `/{tenant_alias}/account/{accountId}/user/{userId}` | Lookup a user |
| GET | `/{tenant_alias}/users` | List users |
| POST | `/{tenant_alias}/account/{accountId}/user/{userId}/block` | Block a user |

## Key resources

- **Accounts** — Operations related to Accounts
- **Exports** — Operations related to Exports
- **Referral Codes** — Operations related to Referral Codes
- **Referrals** — Operations related to Referrals
- **Rewards** — Operations related to Rewards

## Why Jentic

- **Setup:** Wiring the SaaSquatch API by hand means encoding its basic auth, threading your tenant alias into every path against app.referralsaasquatch.com, and handling your own retries. Through Jentic you install once, import the SaaSquatch API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** SaaSquatch puts the account and user ids in the URL path (`/account/{accountId}/user/{userId}/...`), so a rule can pin your agent to one account: it can read that account and its users and nothing else. You choose the operations it may call, so destructive ones like deleting an account or blocking a user are not included unless you add them.
- **Credential handling:** Your SaaSquatch API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'sync an account' or 'look up a user', and Jentic returns the matching SaaSquatch API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the SaaSquatch API use?

The SaaSquatch API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create or update an account with the SaaSquatch API?

Yes. Use the POST /{tenant_alias}/accountsync endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SaaSquatch API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create or update an account through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create or update an account'. Jentic returns the matching SaaSquatch API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SaaSquatch API have?

The SaaSquatch API exposes 22 endpoints covering accounts, exports, referral codes operations.

### Can I limit what my agent is allowed to do with the SaaSquatch API?

Yes. Because you run Jentic One yourself, you decide which SaaSquatch API operations and credentials your agent may use. Since the account and user ids sit in the URL path, such as `/account/{accountId}/user/{userId}`, you can pin the agent to a single account so it only reads that account and its users. Destructive operations like deleting an account or blocking a user stay off limits unless you explicitly add them to the agent's allowed set.