---
title: "Find a Secret"
method: GET
path: "/v1/apps/secrets/find"
---

# Find a Secret

`GET /v1/apps/secrets/find`

## Request

- Base URL: `https://api.stripe.com`
- URL: `https://api.stripe.com/v1/apps/secrets/find`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Finds a secret in the secret store by name and scope.

## Query parameters

- `expand` string[]
- `name` string, required
- `scope` object, required
  - `type` 'account' | 'user', required
  - `user` string

## Response `200`

Successful response.

- AppsSecret: Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends. The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control. All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key. A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions. Related guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects)
  - `created` integer, required: Time at which the object was created. Measured in seconds since the Unix epoch.
  - `deleted` boolean: If true, indicates that this secret has been deleted
  - `expires_at` integer, nullable: The Unix timestamp for the expiry time of the secret, after which the secret deletes.
  - `id` string, required: Unique identifier for the object.
  - `livemode` boolean, required: If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
  - `name` string, required: A name for the secret that's unique within the scope.
  - `object` 'apps.secret', required: String representing the object's type. Objects of the same type share the same value.
  - `payload` string, nullable: The plaintext secret value to be stored.
  - `scope` SecretServiceResourceScope, required
    - `type` 'account' | 'user', required: The secret scope type.
    - `user` string: The user ID, if type is set to "user"

## Other responses

- `default`: Error response.

## Changes

> 19 revisions in range; 7 not diffed, 2 could not be searched.

- **2026-09-25** `8b5c2f03d4cd`: 11 info
  - added the optional property `error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/bancontact/generated_sepa_debit_mandate/anyOf[subschema #2: Mandate]/payment_method_details/card/india` to the response with the `default` status
  - added the optional property `error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/mandate/anyOf[subschema #2: Mandate]/payment_method_details/card/india` to the response with the `default` status
  - added the optional property `error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/ideal/generated_sepa_debit_mandate/anyOf[subschema #2: Mandate]/payment_method_details/card/india` to the response with the `default` status
  - added the optional property `error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/sofort/generated_sepa_debit_mandate/anyOf[subschema #2: Mandate]/payment_method_details/card/india` to the response with the `default` status
  - …7 more
  - …this revision’s changelog is incomplete
- …earlier changes not shown

[Operation history](https://skmtc.dev/stainless-api/apis/stripe-api/changes/v1/apps/secrets/find/get.md)

---

[API](https://skmtc.dev/stainless-api/apis/stripe-api.md) · [All operations](https://skmtc.dev/stainless-api/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc.dev/stainless-api/apis/stripe-api/revisions/7cff4cc46d06?raw)
