Skip to content
docs
Browse the docsVault

API reference

Vault API

Saved credentials, encrypted at rest. Every vault 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.

EndpointSummary
GET /v1/vaultList vault entries
POST /v1/vaultSave a credential
GET /v1/vault/{id}Get a vault entry
PATCH /v1/vault/{id}Change a vault entry
DELETE /v1/vault/{id}Delete a vault entry

List vault entries

GET/v1/vaultvault:readPro and up

Saved credentials without their passwords, pinned first (Pro 50 entries, Business 500).

Query parameters

NameTypeRequiredDescription
searchstringnoWords to find in the site name, email or notes. At most 100 characters.
categorystringnoOnly this category. One of social, shopping, dev-tools, testing, gaming, finance, news, entertainment, work, other.
curl "https://api.dissolve.email/v1/vault" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "entries": [
    {
      "id": "vlt8Yh3NcQ2mZp5Rt0WxK",
      "email": "signup7f2k@dissolve.email",
      "siteName": "GitHub",
      "siteUrl": "https://github.com",
      "category": "dev-tools",
      "notes": null,
      "sourceIdentityId": "idn4Rk2PqT9wYc1Lm0ZxA",
      "pinned": false,
      "createdAt": "2026-11-19T10:05:00.000Z",
      "updatedAt": "2026-11-19T10:05:00.000Z"
    }
  ],
  "limit": 50
}

Save a credential

POST/v1/vaultvault:writePro and up

Stores an email and password for a site, encrypted at rest.

Body (application/json)

NameTypeRequiredDescription
emailstringyesThe sign-in address.
passwordstringyesThe password. At most 1000 characters.
siteNamestringyesThe site, such as GitHub. At most 200 characters.
siteUrlstringnoThe site's address. At most 500 characters.
categorystringnoA category. One of social, shopping, dev-tools, testing, gaming, finance, news, entertainment, work, other.
notesstringnoFree text. At most 1000 characters.
personastringnoA persona as JSON text, stored encrypted.
sourceIdentityIdstringnoThe identity it came from.
curl -X POST "https://api.dissolve.email/v1/vault" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"signup7f2k@dissolve.email","password":"w8#Kq2!vLz9@pR4m","siteName":"GitHub","siteUrl":"https://github.com","category":"dev-tools","sourceIdentityId":"idn4Rk2PqT9wYc1Lm0ZxA"}'

Response 201

JSON
{
  "id": "vlt8Yh3NcQ2mZp5Rt0WxK",
  "email": "signup7f2k@dissolve.email",
  "siteName": "GitHub",
  "siteUrl": "https://github.com",
  "category": "dev-tools",
  "notes": null,
  "sourceIdentityId": "idn4Rk2PqT9wYc1Lm0ZxA",
  "pinned": false,
  "createdAt": "2026-11-19T10:05:00.000Z",
  "updatedAt": "2026-11-19T10:05:00.000Z"
}

Get a vault entry

GET/v1/vault/{id}vault:readPro and up

One entry with its password and persona.

Path parameters

NameDescription
idThe vault id.
curl "https://api.dissolve.email/v1/vault/$ENTRY_ID" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "id": "vlt8Yh3NcQ2mZp5Rt0WxK",
  "email": "signup7f2k@dissolve.email",
  "siteName": "GitHub",
  "siteUrl": "https://github.com",
  "category": "dev-tools",
  "notes": null,
  "sourceIdentityId": "idn4Rk2PqT9wYc1Lm0ZxA",
  "pinned": false,
  "createdAt": "2026-11-19T10:05:00.000Z",
  "updatedAt": "2026-11-19T10:05:00.000Z",
  "password": "w8#Kq2!vLz9@pR4m",
  "persona": null
}

Change a vault entry

PATCH/v1/vault/{id}vault:writePro and up

Changes the site, category, notes or pin. The email and password are fixed: save a new entry to change them.

Path parameters

NameDescription
idThe vault id.

Body (application/json)

NameTypeRequiredDescription
siteNamestringnoThe site. At most 200 characters.
siteUrlstringnoThe site's address, or an empty string to clear it.
categorystring or nullnoA category, or null. One of social, shopping, dev-tools, testing, gaming, finance, news, entertainment, work, other.
notesstring or nullnoFree text, or null. At most 1000 characters.
pinnedbooleannoKeep it at the top of the list.
curl -X PATCH "https://api.dissolve.email/v1/vault/$ENTRY_ID" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pinned":true}'

Response 200

JSON
{
  "updated": true
}

Delete a vault entry

DELETE/v1/vault/{id}vault:writePro and up

Deletes the entry for good.

Path parameters

NameDescription
idThe vault id.
curl -X DELETE "https://api.dissolve.email/v1/vault/$ENTRY_ID" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "deleted": true
}

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