Do not miss any v2 - Secrets API (stable) changes, ever again

Subscribe to the v2 - Secrets API (stable) changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
2026-11-04
20 structure changes including:
20 Modifications
Modified 20 Breaking
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/guest/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/private/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • secret_ttl property Modified
          • Removing polymorphism is always breaking
            Breaking
        • receipt_ttl, lifespan properties Modified
          • Properties are now required
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
GET /api/v2/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • secret_ttl property Modified
          • Removing polymorphism is always breaking
            Breaking
        • receipt_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/secret/{identifier}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-2 alternative Modified
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
10 structure changes including:
10 Modifications
Modified 10
GET /api/v2/guest/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • display_type property Added
GET /api/v2/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • display_type property Added
GET /api/v2/secret/{identifier}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-2 alternative Modified
POST /api/v2/guest/secret/conceal
  • Body
  • application/json content type Modified
    • secret property Modified
      • display_type property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret property Modified
POST /api/v2/guest/secret/generate
  • Body
  • application/json content type Modified
    • secret property Modified
      • display_type property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret property Modified
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • display_type property Added
POST /api/v2/secret/conceal
  • Body
  • application/json content type Modified
    • secret property Modified
      • display_type property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret property Modified
POST /api/v2/secret/generate
  • Body
  • application/json content type Modified
    • secret property Modified
      • display_type property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret property Modified
POST /api/v2/secret/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • display_type property Added
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • display_type property Added
2026-08-22
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /api/v2/guest/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • correct_passphrase property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /api/v2/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • correct_passphrase property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • correct_passphrase property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • correct_passphrase property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /api/v2/version
  • Response
  • 401, 403 responses Added
  • Authentication
  • Session auth, Basic auth authentication methods Added
Added 1
Session authauthentication method
2026-07-06
14 structure changes including:
14 Modifications
Modified 14
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
GET /api/v2/private/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • source property Added
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
GET /api/v2/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • source property Added
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
POST /api/v2/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • share_path, share_url properties Modified
          • Properties are no longer required
          • Type went from string to string | null
        • source property Added
POST /api/v2/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
2026-07-05
8 structure changes including:
8 Modifications
Modified 8
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • first_access, last_access properties Added
2026-06-24
8 structure changes including:
8 Modifications
Modified 8
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration property Modified
          • Property is no longer required
          • Type went from number to number | null
2026-06-23
23 structure changes including:
23 Modifications
Modified 23
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/guest/secret/{identifier}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/private/recent
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/private/{identifier}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/receipt/recent
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/receipt/{identifier}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/secret/{identifier}
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/secret/{identifier}/status
  • Response
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/status
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/supported-locales
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
GET /api/v2/version
  • Response
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
PATCH /api/v2/private/{identifier}
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
PATCH /api/v2/receipt/{identifier}
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/guest/secret/conceal
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/guest/secret/generate
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/private/{identifier}/burn
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/secret/conceal
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/secret/generate
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/secret/status
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 400 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 401 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 403 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 404 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 422 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 429 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
  • 500 response Modified
    • application/json content type Modified
      • message property Modified
        • Property is no longer required
      • error_type, request_id properties Added
14 structure changes including:
14 Modifications
Modified 14
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
GET /api/v2/private/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • recipient_name property Added
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
GET /api/v2/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • recipient_name property Added
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v2/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v2/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
2 structure changes including:
2 Modifications
Modified 2
GET /api/v2/private/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • received, notreceived properties Modified
          • Properties are no longer required
GET /api/v2/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • received, notreceived properties Modified
          • Properties are no longer required
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /api/v2/secret/{identifier}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
GET /api/v2/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success property Added
GET /api/v2/supported-locales
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success property Added
GET /api/v2/version
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success property Added
POST /api/v2/guest/secret/conceal
  • Response
  • 429 response Added
POST /api/v2/guest/secret/generate
  • Response
  • 429 response Added
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 429 response Added
POST /api/v2/secret/conceal
  • Response
  • 429 response Added
POST /api/v2/secret/generate
  • Response
  • 429 response Added
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 429 response Added
2026-03-24
12 structure changes including:
12 Modifications
Modified 12
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
POST /api/v2/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • custid, owner_id properties Modified
          • Type went from string to string | null
POST /api/v2/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v2/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified