Sample - Stripe API
GET/v1/apps/secrets/find

Find a secret

Retrieves a secret from Secret Store by its name and scope. Supply name together with scope to identify the secret, and use expand when additional response fields are needed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
expandarray<string>optional
Specifies response fields to expand; each value can be up to 5000 characters.
namestringrequired
The secret name, which must be unique within its scope. Maximum 5000 characters.
scopeobjectrequired
The secret scope object. Its `type` must be `account` or `user`; user-scoped requests can include the user identifier in `user`.

2 status codes
200Returns the matching secret with its identifier, name, scope, lifecycle timestamps, payload, and live-mode status.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
deletedbooleanoptional
If true, indicates that this secret has been deleted
expires_atintegeroptional
The Unix timestamp for the expiry time of the secret, after which the secret deletes.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
namestringrequired
A name for the secret that's unique within the scope.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:apps.secret
payloadstringoptional
The plaintext secret value to be stored.
scopeobjectrequired
defaultError response.
errorobjectrequired

Error handling

name is required and cannot exceed 5000 characters. scope is required and its type must be either account or user; include the user identifier when locating a user-scoped secret.