# API v3 (alpha)

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

## Description

This is version `2026-08-26` of this API documentation. Last update on Aug 26, 2026.
Our next-generation API. Similar to v2 with JSON types and new endpoints, but still evolving. Although we use the v3 API to power our UI, it is not recommended for production use externally until we reach stable status. Subject to change without deprecation.

## 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

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


## Endpoints

### [Feedback](https://api.onetimesecret.com/doc/v3-api/group/endpoint-feedback.md)

- [Receive Feedback](https://api.onetimesecret.com/doc/v3-api/operation/operation-v3_receivefeedback.md)


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

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

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

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

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

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

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

- [Show Multiple Receipts](https://api.onetimesecret.com/doc/v3-api/operation/operation-v3_showmultiplereceipts.md)


### [Incoming](https://api.onetimesecret.com/doc/v3-api/group/endpoint-incoming.md)

- [Get Config](https://api.onetimesecret.com/doc/v3-api/operation/operation-incoming_getconfig.md)

- [Create Incoming Secret](https://api.onetimesecret.com/doc/v3-api/operation/operation-incoming_createincomingsecret.md)

- [Validate Recipient](https://api.onetimesecret.com/doc/v3-api/operation/operation-incoming_validaterecipient.md)


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

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

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

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

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


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

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

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

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

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

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

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


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

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


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

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


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

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




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