API reference / Vault
Get a vault item
One vault item: its fields (concealed values never included), sites, tags and who added it.
/api/v1/vault/items/{id}Other ways to call it
troopy vault gettroopy_get_vault_itemPath parameters
id*stringA 24-character id
Response
200 · application/jsondata*object18 properties
id*stringA 24-character id
collection*object2 properties
id*stringA 24-character id
name*stringkind*enum<string>loginapi_keysecretnotecard
name*stringtags*array<string>urls*array<string>Logins: the pages it signs in on. API keys: the service's address
sites*array<string>The domains of urls: where a teammate may use a login
environment*enum<string> | nullAPI keys: test or live
testlive
expiresAt*string | nullfields*array<object>7 properties
key*stringStable: references (troopy://vault/<item>/<key>) name it
label*stringtype*enum<string>textemailurlpasswordtotpmonthmultiline
concealed*booleanConcealed values never leave through the API; people see them in the app after unlocking
value*string | nullThe value when it isn't concealed; null when concealed or empty
hint*string | nullA long key's or card number's last four characters
set*booleanWhether it has a value
status*enum<string>unconfirmed: a login a teammate made signing up, until it signs in with it or a person confirms it
activeunconfirmed
importedFrom*enum<string> | null1passwordbitwardenlastpasschrome
createdBy*objectWho added it: a person, a teammate (type agent) or an API key
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringlevel*enum<string>What you may do with it
viewusemanage
createdAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
lastUsedAt*string | null