Skip to main content
GET
List Vault Share Links

Authorizations

X-Api-Key
string
header
required

Query Parameters

organizationId
string<uuid>
required

Response

The request has succeeded.

createdAt
string<date-time>
required
createdBy
string<uuid>
required
expiresAt
string<date-time>
required
failedSubmits
integer<int32>
required

Submits that resolved this link but did not complete it: invalid values, a dead link, or a lost race.

fields
object[]
required
id
string<uuid>
required
itemKey
string
required

Derived from name: kebab-case. Unique per organisation. Reserved while the link is pending.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
kind
enum<string>
required

Kind of vault item. Templates and items need at least one field. Completeness is per-field required.

Available options:
login,
api_key,
card,
custom
name
string
required

Item name the submit will create.

Required string length: 1 - 200
organizationId
string<uuid>
required
status
enum<string>
required

Lifecycle of a share link. expired is derived from expiresAt; the other three are stored.

Available options:
pending,
completed,
expired,
revoked
steps
object[]
required
Maximum array length: 20
title
string
required
Required string length: 1 - 200
updatedAt
string<date-time>
required
completedAt
string<date-time>
description
string
Maximum string length: 2000
lastFailedSubmitAt
string<date-time>

When the most recent failed submit happened.

resultItemId
string<uuid>

Item created by the submit. Set when status is completed.

submittedIp
string

Client address the completing submit came from. Set when status is completed.

submittedUserAgent
string

User agent of the completing submit. Set when status is completed.

templateId
string<uuid>

Template the blueprint was copied from. Provenance only.