Skip to main content
GET
/
vaults
/
{vaultUuid}
/
items
Get all items for inside a Vault
curl --request GET \
  --url http://localhost:8080/v1/vaults/{vaultUuid}/items \
  --header 'Authorization: Bearer <token>'
[
  {
    "vault": {
      "id": "<string>"
    },
    "category": "LOGIN",
    "id": "<string>",
    "title": "<string>",
    "urls": [
      {
        "primary": true,
        "href": "https://example.com"
      },
      {
        "href": "https://example.org"
      }
    ],
    "favorite": false,
    "tags": [
      "<string>"
    ],
    "version": 123,
    "state": "ARCHIVED",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "lastEditedBy": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vaultUuid
string
required

The UUID of the Vault to fetch Items from

Pattern: ^[\da-z]{26}$

Query Parameters

​
filter
string

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

Example:

"title eq \"Some Item Name\""

Response

OK

​
vault
object
required
​
category
enum<string>
required
Available options:
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
​
id
string
Pattern: ^[\da-z]{26}$
​
title
string
​
urls
object[]
Example:
[
  {
    "primary": true,
    "href": "https://example.com"
  },
  { "href": "https://example.org" }
]
​
favorite
boolean
default:false
​
tags
string[]
​
version
integer
​
state
enum<string>
Available options:
ARCHIVED,
DELETED
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
lastEditedBy
string