# Show Secret Status

**GET /api/v2/secret/{identifier}/status**

Checks whether a secret exists and returns its current state without consuming it or changing it. Returns the secret's metadata including expiration details, or a state of "unknown" if the secret does not exist. The access is recorded as telemetry on the secret's receipt, visible to the secret's creator.


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


## Authentication methods
- Basic auth


## Parameters

### Path parameters

- **identifier** (string)
  The identifier parameter




## Responses
### 200
Successful response

#### Body: application/json (object)
- **record** (object)


### 401
Unauthorized - Authentication required

#### Body: application/json (object)
- **error** (string)
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

- **error_type** (string)
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

- **message** (string)
  Human-readable error message (legacy/V1 shape)

- **field** (string)
  Field that caused the error, if applicable

- **error_id** (string)
  Unique error tracking identifier

- **request_id** (string)
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.


### 403
Forbidden - Insufficient permissions

#### Body: application/json (object)
- **error** (string)
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

- **error_type** (string)
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

- **message** (string)
  Human-readable error message (legacy/V1 shape)

- **field** (string)
  Field that caused the error, if applicable

- **error_id** (string)
  Unique error tracking identifier

- **request_id** (string)
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.


### 404
Not Found - Resource does not exist

#### Body: application/json (object)
- **error** (string)
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

- **error_type** (string)
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

- **message** (string)
  Human-readable error message (legacy/V1 shape)

- **field** (string)
  Field that caused the error, if applicable

- **error_id** (string)
  Unique error tracking identifier

- **request_id** (string)
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.


### 500
Internal Server Error - Something went wrong

#### Body: application/json (object)
- **error** (string)
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

- **error_type** (string)
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

- **message** (string)
  Human-readable error message (legacy/V1 shape)

- **field** (string)
  Field that caused the error, if applicable

- **error_id** (string)
  Unique error tracking identifier

- **request_id** (string)
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.



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