# API v2

OpenAPI file: https://api.onetimesecret.com/doc/api-v2.json

## Description

This is version `2026-11-08` of this API documentation. Last update on Nov 8, 2026.
Our current stable API. JSON-based, with improved consistency and new endpoints compared to v1. Actively maintained and recommended for production use. Receives new features and updates, but breaking changes are avoided or properly deprecated.

## Servers

- Aotearoa New Zealand: https://nz.onetimesecret.com (Aotearoa New Zealand)

- Canada: https://ca.onetimesecret.com (Canada)

- Europe: https://eu.onetimesecret.com (Europe)

- United Kingdom: https://uk.onetimesecret.com (United Kingdom)

- United States: https://us.onetimesecret.com (United States)

- Development: http://localhost:3000 (Development)


## Topics

### [Authentication](https://api.onetimesecret.com/doc/api-v2/authentication.md)


## Endpoints

### [Guest](https://api.onetimesecret.com/doc/api-v2/group/endpoint-guest.md)

- [Conceal Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_concealsecret.md)

- [Generate Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_generatesecret.md)

- [Show Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_showsecret.md)

- [Reveal Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_revealsecret.md)

- [Show Receipt](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_showreceipt.md)

- [Burn Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_guest_burnsecret.md)


### [Private](https://api.onetimesecret.com/doc/api-v2/group/endpoint-private.md)

- [List Receipts](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_private_listreceipts.md)

- [Burn Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_private_burnsecret.md)

- [Show Receipt](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_private_showreceipt.md)

- [Update Receipt](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_private_updatereceipt.md)


### [Receipt](https://api.onetimesecret.com/doc/api-v2/group/endpoint-receipt.md)

- [List Receipts](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_listreceipts.md)

- [Burn Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_receipt_burnsecret.md)

- [Show Receipt](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_showreceipt.md)

- [Update Receipt](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_updatereceipt.md)


### [Secret](https://api.onetimesecret.com/doc/api-v2/group/endpoint-secret.md)

- [Show Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_showsecret.md)

- [Show Secret Status](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_secret_showsecretstatus.md)

- [List Secret Status](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_listsecretstatus.md)

- [Reveal Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_secret_revealsecret.md)

- [Generate Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_generatesecret.md)

- [Conceal Secret](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_concealsecret.md)


### [Status](https://api.onetimesecret.com/doc/api-v2/group/endpoint-status.md)

- [System Status](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_systemstatus.md)


### [Supported locales](https://api.onetimesecret.com/doc/api-v2/group/endpoint-supported-locales.md)

- [Get Supported Locales](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_getsupportedlocales.md)


### [Version](https://api.onetimesecret.com/doc/api-v2/group/endpoint-version.md)

- [System Version](https://api.onetimesecret.com/doc/api-v2/operation/operation-v2_systemversion.md)




[Powered by Bump.sh](https://bump.sh)
