Get Vault details and metadata

GET

/vaults/{vaultUuid}

const url = 'http://1password.local/vaults/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://1password.local/vaults/example \
  --header 'Authorization: Bearer <token>'

Authorizations

ConnectToken

Parameters

Path Parameters

vaultUuid

required

string

/^[\da-z]{26}$/

The UUID of the Vault to fetch Items from

Responses

200

object

attributeVersion

The vault version

integer

contentVersion

The version of the vault contents

integer

createdAt

string format: date-time

description

string

/^[\da-z]{26}$/

items

Number of active items in the vault

integer

name

string

type

string

Allowed values: USER_CREATED PERSONAL EVERYONE TRANSFER

updatedAt

string format: date-time

401

Invalid or missing token

object

message

A message detailing the error

string

status

HTTP Status Code

integer

Example

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

403

Unauthorized access

object

message

A message detailing the error

string

status

HTTP Status Code

integer

Example

{
  "message": "vault {vaultUuid} is not in scope",
  "status": 403
}

404

Vault not found

object

message

A message detailing the error

string

status

HTTP Status Code

integer

Example

{
  "message": "vault {itemUuid} not found",
  "status": 404
}