canonical: https://jentic.com/apis/whapi.com/accounts-api

# Whapi Accounts API

The Accounts API is a collection of methods used to query a customer account. It allows the developer to retrieve account-related data such as the user account balance. It should be noted that regional variations may exist - so some fields may not be returned for certain territories. The API exposes 9 endpoints.

## For AI agents

Programmatically retrieves details of a customers account, get a customers account balance. Covers 9 operations.

## Scope

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

## Capabilities

- Retrieves details of a customers account
- Get a customers account balance
- Sets a flag based on name to value provided for the user.
- Query and filter Accounts API records by parameters
- Monitor Accounts API operational status and events

## Use cases

### Productivity Operations

Use the Accounts API to perform productivity operations programmatically. The API provides 9 endpoints covering core functionality including retrieves details of a customers account, get a customers account balance, sets a flag based on name to value provided for the user..

Example prompt: Call GET /account to retrieves details of a customers account

### Automated Account Management

Automate account operations by combining multiple Accounts API endpoints. Agents can get a customers account balance and then sets a flag based on name to value provided for the user. in a single workflow.

Example prompt: Call GET /account/balance to get a customers account balance, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Accounts 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 none tokens manually.

Example prompt: Search Jentic for 'retrieves details of a customers account', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /account | Retrieves details of a customers account |
| GET | /account/balance | Get a customers account balance |
| POST | /account/flags | Sets a flag based on name to value provided for the user. |
| GET | /account/payments | Gets a customer's account payments |
| GET | /account/plusCard | Gets a customer's plus card details if they exist. |
| POST | /account/plusCard/lostStolen | Sets a customer's plus card as Lost/Stolen |
| POST | /account/plusCard/phone/{oldPhoneNumber} | Sets a customer's plus card phone number |
| POST | /account/plusCard/pin | Sets a customer's plus card pin |

## Key resources

- **Account** — Operations for account

## Why Jentic

- **Setup:** Wiring this Accounts API by hand means pointing requests at its sandbox.whapi.com host, wiring each account operation, and handling retries yourself. Through Jentic you install once, import the Accounts API from the API Directory, and your agent calls it.
- **Permission scoping:** This Accounts API carries account details in the request body rather than pinning to one account in the path, so limit the agent to the operations it needs, such as reading account details or balance. You choose the operations it may call, so plusCard actions like reporting a card lost or changing its PIN are not included unless you add them.
- **Credential handling:** This Accounts API declares no authentication in its spec, so there is no credential to store; if your instance later adds one, Jentic One stores it once, encrypted, and injects it at execution time so it never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a customer's account details' or 'read the account balance', and Jentic returns the matching Accounts API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the Accounts API use?

The Accounts API uses no authentication. 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 retrieves details of a customers account with the Accounts API?

Yes. Use the GET /account endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Accounts 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 retrieves details of a customers account through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrieves details of a customers account'. Jentic returns the matching Accounts API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The Accounts API exposes 9 endpoints covering account operations.

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

Yes. Jentic One is self-hosted, so you run it and your own rules decide which Accounts API operations and credentials the agent may use. Because this API carries account details in the request body rather than pinning to a single account in the path, you can restrict the agent to just the read operations it needs, such as GET /account for account details or GET /account/balance for the balance. Write actions on the plusCard, like reporting a card lost or stolen via POST /account/plusCard/lostStolen or changing the PIN via POST /account/plusCard/pin, stay off limits until you explicitly grant them.
