Swagger Petstore - OpenAPI 3.0
GET/v1/apps/secrets

List secrets

Lists all secrets stored on the given scope. Secrets are scoped to provide permission control — requests from UI extensions can only access account-scoped secrets or secrets scoped to their own user. Use limit and cursor parameters to paginate through results.

5 parameters
ending_beforestringoptional

A cursor for pagination. Pass an object ID to fetch the previous page of results before this ID.

expandarray<string>optional

Specifies which fields in the response should be expanded.

limitintegeroptional

Maximum number of secrets to return. Must be between 1 and 100. Defaults to 10 if omitted.

scopeobjectrequired

Specifies the scoping of the secret. Must be an object with type set to account or user, and optionally a user field for user-scoped secrets.

starting_afterstringoptional

A cursor for pagination. Pass an object ID to fetch the next page of results after this ID.

2 status codes
200Returns a paginated list of secret objects with metadata including creation time, expiry, scope, and whether more results exist.
dataarray<Secret>required
has_morebooleanrequired

True if this list has another page of items after this one that can be fetched.

objectstringrequired

String representing the object's type. Objects of the same type share the same value. Always has the value list.

Allowed:list
urlstringrequired

The URL where this list can be accessed.

defaultError response.
errorobjectrequired

Error handling

scope is required and must be an object with a type field set to either account or user. If type is user, the user field must also be provided. limit must be a positive integer between 1 and 100; the default is 10.