Account API
Check account status, quota and usage. (Coming soon)
Account API
Check your account status at any time. The endpoint responds with quota levels and current usage (e.g. message credits). Usage typically resets on a recurring basis. This is a placeholder - details to be added.
Endpoint
| Method | Path |
|---|---|
| GET | /account (placeholder - details to be confirmed) |
Headers: Api-Key: your_api_key_here, Content-Type: application/json
Request
Request parameters
| Parameter | Type | Description |
|---|---|---|
| (none) | - | No request body; authentication via Api-Key header. |
Notes
- Placeholder: request notes and example to be added.
Example request
curl -X GET "https://app.upscaleoutreach.com/api/v2/account" \
-H "Api-Key: your_api_key_here" \
-H "Content-Type: application/json"Response
On success (200), the response returns account details including quota and usage. Placeholder structure below - to be updated with actual fields.
200 OK - Success
Error response examples
Unauthorized (401):
200 OK — Success
{
"created_at": "2024-01-15T10:00:00Z",
"plan_name": "Placeholder plan",
"monthly_credits": 0,
"monthly_allowance": 1000
}