Skip to main content
GET

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

id
string
required

The unique identifier of the vault

Query Parameters

includeUnconfirmed
boolean
default:false

Include placeholders for uploads that were never completed (awaiting_upload) or were cancelled (aborted). Excluded by default.

file_origin
string

JSON-encoded provenance object used as a partial match. For example, {"provider":"clio"} returns objects whose file_origin contains that value.

Example:

"{\"provider\":\"clio\"}"

Response

Successfully retrieved vault objects

vaultId
string
required

The ID of the vault

objects
object[]
required
count
number
required

Total number of objects in the vault