- Introduction
- Concepts
- Authentication
- Webhooks
- Envelope lifecycle
- Error handling
- Contact
- Document
- Envelope
- Get envelope certificate file
- Process envelope certificate
- Get envelope
- Update envelope
- Remove envelope
- Create envelope
- List available envelope owners
- Change envelope user account owner
- Rename envelope
- Move envelope
- Publish envelope
- Unschedule envelope publication
- Hold envelope
- Cancel envelope
- Restore envelope
- Manual reinvite to review envelope
- Create signature link
- Template
- Vault
Get vault
GET
https://api.signater.com/v1/ecm/vaults/{vaultId}
Vault
Last modified:2025-03-29 12:47:42
Request
Authorization
Add parameter in header
x-api-token
Example:
x-api-token: ********************
Path Params
vaultId
string <uuid>
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.signater.com/v1/ecm/vaults/' \
--header 'x-api-token;'
Responses
🟢200OK
application/json
Body
id
string <uuid>
optional
name
string | null
optional
type
enum<string>
optional
Allowed values:
AccountUserAccountUserAccountGroup
description
string | null
optional
userAccountMembers
array[object (GetVaultUserAccountMemberApiResponse) {3}] | null
optional
id
string <uuid>
optional
name
string | null
optional
avatar
string | null
optional
Example
{
"id": "044791c3-ebc3-4173-9c2b-e7b13d00aff0",
"name": "Example Vault",
"type": "UserAccount",
"description": "This is an example of a vault used for demonstration purposes.",
"userAccountMembers": [
{
"id": "1f982af3-ef1d-45d1-a605-2783f0c45121",
"name": "John Doe",
"avatar": null
},
{
"id": "973927da-d4a9-47c6-87be-1cf19f8d5d7a",
"name": "Jane Smith",
"avatar": "https://example.com/avatars/janesmith.png"
}
]
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found