API Reference
Settings
The Settings API allows you to retrieve account configuration and plan limits.
Base URL
https://api.unsent.dev/v1/settingsFeatures
Account Info
View team ID and name
Plan Limits
Check your daily and monthly email quotas
Overview
The Settings API provides a single endpoint to retrieve your team's configuration, plan information, and email sending limits. This is useful for checking quotas, displaying account information, and validating your plan status.
Quick Start
Get Settings
Retrieve your team's settings and current plan limits.
curl -X GET https://api.unsent.dev/v1/settings \
-H "Authorization: Bearer your-api-key"Example Response (FREE Plan):
{
"id": "team_abc123",
"name": "My Team",
"plan": "FREE",
"dailyEmailLimit": 100,
"monthlyEmailLimit": 3000
}Example Response (PREMIUM Plan):
{
"id": "team_xyz789",
"name": "Enterprise Team",
"plan": "PREMIUM",
"dailyEmailLimit": 50000,
"monthlyEmailLimit": -1
}[!NOTE] A
monthlyEmailLimitof-1indicates unlimited emails for PREMIUM plans.
Response Schema
The GET /v1/settings endpoint returns the following fields:
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for your team |
name | string | Your team's display name |
plan | string | Current plan type (FREE or PREMIUM) |
dailyEmailLimit | number | Maximum emails that can be sent per day |
monthlyEmailLimit | number | Maximum emails per month (-1 for unlimited) |
Use Cases
Quota Monitoring
Check remaining email quota before sending campaigns
Plan Validation
Verify your current plan and available features