Skip to content

Get all items for inside a Vault

GET
/vaults/{vaultUuid}/items
vaultUuid
required
string
/^[\da-z]{26}$/

The UUID of the Vault to fetch Items from

filter
string
title eq "Some Item Name"

Filter the Item collection based on Item name using SCIM eq filter

OK

Array<object>
object
category
required
string
Allowed values: LOGIN PASSWORD API_CREDENTIAL SERVER DATABASE CREDIT_CARD MEMBERSHIP PASSPORT SOFTWARE_LICENSE OUTDOOR_LICENSE SECURE_NOTE WIRELESS_ROUTER BANK_ACCOUNT DRIVER_LICENSE IDENTITY REWARD_PROGRAM DOCUMENT EMAIL_ACCOUNT SOCIAL_SECURITY_NUMBER MEDICAL_RECORD SSH_KEY CUSTOM
createdAt
string format: date-time
favorite
boolean
id
string
/^[\da-z]{26}$/
lastEditedBy
string
state
string
Allowed values: ARCHIVED DELETED
tags
Array<string>
title
string
updatedAt
string format: date-time
urls
Array<object>
object
href
required
string format: url
label
string
primary
boolean
[
{
"href": "https://example.com",
"primary": true
},
{
"href": "https://example.org"
}
]
vault
required
object
id
required
string
/^[\da-z]{26}$/
version
integer

Invalid or missing token

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
"message": "Invalid token signature",
"status": 401
}

Vault not found

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
"message": "vault {vaultUuid} not found",
"status": 404
}