Get all secrets

get

https://example.com/beyondtrust/api/public/v3/secrets-safe/secrets

Returns a list of secrets accessible to the current user and filtered by the specified query parameters.

Required Permission(s)

Any of the following:

Secrets Safe (Read)
Workforce Passwords (Read)

Notes

If no secrets match the specified filter parameter(s), a 200 (OK) response with an empty list is expected

API Versions

Version 3.2 - Includes SecretValueModifiedOn in applicable response models
Version 3.1 - Using Owners collection
Version 3.0 - Using obsolete owner properties

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Path

string

length between 0 and 1798

Secret filters applied when getting them

Title

string

length between 0 and 256

Full title of the secret

Separator

string

length between 0 and 1

Character used to separate the folder names in the Path property. Default is '/'

AfterDate

date-time

Filter by modified or created on, after, or equal to the given date. Must be in the following UTC format: yyyy-MM-ddTHH:mm:ssZ

SecretValueAfterDate

date-time

Filter secret value date by modified or created on, after, or equal to the given date. Must be in the following UTC format: yyyy-MM-ddTHH:mm:ssZ

Limit

int32

Defaults to 1000

Maximum number of secrets to return

Offset

int32

Defaults to 0

Number of secrets to skip

Decrypt

boolean

Defaults to false

Include the decrypted password or text in the results

Favorite

boolean

Filter by favorite status. When true, returns only the caller's favorited secrets; when false, only non-favorited. Omit to return all.

version

string

Defaults to 3.0

API version for response format

Responses

200Successfully retrieved accessible secrets

403Insufficient permissions to view secrets