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>'
import requests

url = "http://localhost:8080/v1/vaults/{vaultUuid}/items"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/v1/vaults/{vaultUuid}/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/vaults/{vaultUuid}/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:8080/v1/vaults/{vaultUuid}/items"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:8080/v1/vaults/{vaultUuid}/items")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/v1/vaults/{vaultUuid}/items")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "vault": {
      "id": "<string>"
    },
    "id": "<string>",
    "title": "<string>",
    "urls": [
      {
        "primary": true,
        "href": "https://example.com"
      },
      {
        "href": "https://example.org"
      }
    ],
    "favorite": false,
    "tags": [
      "<string>"
    ],
    "version": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "lastEditedBy": "<string>"
  }
]
{
"status": 401,
"message": "Invalid token signature"
}
{
"status": 404,
"message": "vault {vaultUuid} not found"
}

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>
read-only
Available options:
ARCHIVED,
DELETED
createdAt
string<date-time>
read-only
updatedAt
string<date-time>
read-only
lastEditedBy
string
read-only