Developer REST API

Automate your alias fleet via REST API.

Provision aliases, register custom domains, manage verified destinations, configure conditional routing rules, and send outbound messages over TLS 1.3 using fine-grained afp_ API keys with 21 resource:action permission scopes.

52-character afp_ scoped keys
21 resource:action scopes
Idempotency-Key outbound support

Built for programmatic workflows and internal tooling

Integrate AliasFleet into CI pipelines, user onboarding tools, or security automation without sharing full account session credentials.

Granular scoped API keys

Generate keys in Settings -> Developer API carrying an afp_ prefix and restrict access to exact read or write scopes like aliases:write or webhooks:read.

Full resource coverage

Manage aliases, destinations, custom domains, subdomains, categories, sender rules, conditional rules, webhooks, activity logs, and security alerts.

Predictable rate limit windows

Sliding-window limits apply cleanly: 60 req/min standard, 10 req/min on POST /v1/aliases, and 5 req/min on POST /v1/quick-send with Idempotency-Key support.

Custom domains and TTL via API

Provision verified custom domains via API and pass alias_ttl_days or expires_at for time-bounded custom-domain aliases.

Authenticate and provision aliases in seconds

All endpoints are served over HTTPS TLS 1.3 at https://api.aliasfleet.com using Authorization: Bearer afp_... or x-api-key headers.

create-alias.shPOST /v1/aliases
curl -X POST "https://api.aliasfleet.com/v1/aliases" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "newsletter",
    "domain_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "description": "Weekly Tech Digest",
    "forward_to_email": "inbox@company.com"
  }'
verify-key.shGET /v1/me
curl -X GET "https://api.aliasfleet.com/v1/me" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Accept: application/json"

REST API availability by plan

Developer API keys (api_access) are available on the Business plan, alongside unlimited aliases, unlimited bandwidth, unlimited rules, and unlimited webhooks.

CapabilityFreeProBusiness
Developer API keys (afp_...)Not includedNot includedEnabled (21 scopes)
Programmatic alias creation & TTLDashboard / ExtensionDashboard / ExtensionPOST /v1/aliases (10 req/min)
Outbound Quick-Send APINot includedDashboard onlyPOST /v1/quick-send + Idempotency-Key
Webhook & Rule API automationNot includedDashboard onlyFull read/write endpoints
Activity log & X-Ray export API7-day dashboard logs30-day dashboard logs90-day logs + activity:read API

Continue exploring developer docs

Read complete endpoint contracts or jump into webhooks and conditional filtering.

REST API documentation

Authentication, permission scopes, entity identifiers, and endpoint specifications.

Explore

Email Webhooks

Receive inbound messages over HTTPS with HMAC-SHA256 verification.

Explore

Email Filtering & Routing

Build automated header, subject, and regex filtering pipelines.

Explore

Email Alias API questions

Authentication, scopes, rate limits, and plan eligibility for the AliasFleet REST API.

Developer API keys (api_access) are included in the Business plan. Free and Pro accounts manage aliases, rules, and destinations through the web dashboard and browser extensions.