Skip to content
docs
Browse the docsAccount

API reference

Account API

The credential, the account and the receiving domains. Every account endpoint with its scope, parameters, body and an example answer.

Base URL https://api.dissolve.email. Send an API key or OAuth access token as Authorization: Bearer <token> (Authentication); an OAuth token needs the scope on each endpoint. Errors follow one shape.

Describe this credential

GET/v1/connectionAny connection

What the bearer credential is: an API key (kind user or cli, scopes *) or an OAuth connection (kind mcp or app, the scopes the person approved), its per-minute rate and the resource an OAuth token was issued for. Needs no scope.

curl "https://api.dissolve.email/v1/connection" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "kind": "user",
  "clientId": null,
  "scopes": [
    "*"
  ],
  "requestsPerMinute": 100,
  "resource": null
}

Get the account and its limits

GET/v1/meprofile

The account id, plan, subscription status and the limits that matter to an API caller. The email address is included only when the connection has the email scope.

curl "https://api.dissolve.email/v1/me" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "id": "usr7Np2QkX9mVc4Rt1ZbL",
  "email": "you@example.com",
  "plan": "pro",
  "subscriptionStatus": "active",
  "limits": {
    "maxInboxes": 10,
    "inboxDurationMinutes": 30,
    "maxAliasesPerInbox": 5,
    "customInboxNames": true,
    "agentIdentities": true,
    "maxAgentIdentities": 10,
    "agentWaitTimeoutSeconds": 30,
    "vault": true,
    "requestsPerMinute": 100
  },
  "connection": {
    "kind": "user",
    "clientId": null,
    "scopes": [
      "*"
    ]
  }
}

List the domains for new addresses

GET/v1/domainsAny connection

The receiving domains a new inbox or identity can use, and the default. Pro and Business may choose one with domain when creating; Free always gets the default.

curl "https://api.dissolve.email/v1/domains" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "domains": [
    {
      "id": "d-0",
      "domain": "dissolve.email",
      "isDefault": true
    }
  ],
  "defaultDomain": "dissolve.email"
}

Something wrong or missing on this page? Tell us at support@dissolve.email.View as Markdown