Do not miss any Official Secrets API Hub changes, ever again

Subscribe to the Official Secrets API Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
v3 - Secrets API (preview)
11 structure changes including:
11 Modifications
Modified 11
GET /api/v3/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
GET /api/v3/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • recipient_name property Added
      • details property Modified
        • revealed_receipts, pending_receipts properties Modified
GET /api/v3/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
PATCH /api/v3/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v3/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v3/guest/receipts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • recipient_name property Added
      • details property Modified
        • revealed_receipts, pending_receipts properties Modified
POST /api/v3/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v3/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v3/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • recipient_name property Added
POST /api/v3/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
POST /api/v3/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
v2 - Secrets API (stable)
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
v3 - Secrets API (preview)
2026-04-15
2 structure changes including:
2 Modifications
Modified 2
GET /api/incoming/config
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config property Added
POST /api/incoming/secret
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success, message, shrimp, custid, record, details properties Added
v3 - Secrets API (preview)
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/incoming/config
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user_id, shrimp, record, details properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/incoming/secret
  • Body
  • application/json content type Modified
    • recipient property Modified
      • Type went from object to string
        Breaking
      • * property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success, message, shrimp, custid, record, details properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/incoming/validate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user_id, shrimp, record, details properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • recipient, valid properties Added
v2 - Secrets API (stable)
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
v3 - Secrets API (preview)
10 structure changes including:
3 Additions
7 Modifications
Modified 7
POST /api/v3/feedback
  • Response
  • 429 response Added
POST /api/v3/guest/secret/conceal
  • Response
  • 429 response Added
POST /api/v3/guest/secret/generate
  • Response
  • 429 response Added
POST /api/v3/guest/secret/{identifier}/reveal
  • Response
  • 429 response Added
POST /api/v3/secret/conceal
  • Response
  • 429 response Added
POST /api/v3/secret/generate
  • Response
  • 429 response Added
POST /api/v3/secret/{identifier}/reveal
  • Response
  • 429 response Added
Added 3
GET /api/incoming/config
POST /api/incoming/secret
POST /api/incoming/validate
v2 - Secrets API (stable)
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
v1 - Secrets API (legacy)
4 structure changes including:
4 Modifications
Modified 4
POST /api/v1/create
  • Response
  • 429 response Added
POST /api/v1/generate
  • Response
  • 429 response Added
POST /api/v1/secret/{key}
  • Response
  • 429 response Added
POST /api/v1/share
  • Response
  • 429 response Added
v3 - Secrets API (preview)
v2 - Secrets API (stable)
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
v2 - Secrets API (stable)
v1 - Secrets API (legacy)