# Vault API

> Canonical URL: https://developers.apideck.com/apis/vault/reference

Welcome to the Vault API 👋

When you're looking to connect to an API, the first step is authentication.

Vault helps you handle OAuth flows, store API keys, and refresh access tokens from users (called consumers in Apideck).

## Base URL

## Resources

### Consumers

Full resource: [https://developers.apideck.com/md/apis/vault/reference/consumers.md](https://developers.apideck.com/md/apis/vault/reference/consumers.md)

- **GET /vault/consumers** — Get all consumers · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumersAll.md)
- **POST /vault/consumers** — Create consumer · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumersAdd.md)
- **GET /vault/consumers/{consumer_id}** — Get consumer · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumersOne.md)
- **DELETE /vault/consumers/{consumer_id}** — Delete consumer · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumersDelete.md)
- **PATCH /vault/consumers/{consumer_id}** — Update consumer · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumersUpdate.md)
- **GET /vault/consumers/{consumer_id}/stats** — Consumer request counts · [markdown](https://developers.apideck.com/md/apis/vault/reference/consumers/consumerRequestCountsAll.md)

### Connections

Full resource: [https://developers.apideck.com/md/apis/vault/reference/connections.md](https://developers.apideck.com/md/apis/vault/reference/connections.md)

- **GET /vault/connections** — Get all connections · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsAll.md)
- **GET /vault/connections/{unified_api}/{service_id}** — Get connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsOne.md)
- **POST /vault/connections/{unified_api}/{service_id}** — Create connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsAdd.md)
- **DELETE /vault/connections/{unified_api}/{service_id}** — Deletes a connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsDelete.md)
- **PATCH /vault/connections/{unified_api}/{service_id}** — Update connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsUpdate.md)
- **POST /vault/connections/{unified_api}/{service_id}/import** — Import connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsImport.md)
- **POST /vault/connections/{unified_api}/{service_id}/token** — Authorize Access Token · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsToken.md)
- **POST /vault/connections/{unified_api}/{service_id}/validate** — Validate Connection State · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/validateConnectionState.md)
- **GET /vault/connections/{unified_api}/{service_id}/consent** — Get consent records · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionConsentsAll.md)
- **PATCH /vault/connections/{unified_api}/{service_id}/consent** — Update consent state · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionConsentUpdate.md)
- **POST /vault/connections/{unified_api}/{service_id}/callback-state** — Create Callback State · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/createCallbackState.md)
- **GET /vault/connections/{unified_api}/{service_id}/{resource}/config** — Get resource settings · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionSettingsAll.md)
- **PATCH /vault/connections/{unified_api}/{service_id}/{resource}/config** — Update settings · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionSettingsUpdate.md)
- **GET /vault/connections/{unified_api}/{service_id}/{resource}/schema** — Get resource schema · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsSchema.md)
- **GET /vault/connections/{unified_api}/{service_id}/{resource}/example** — Get resource example · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsExample.md)
- **GET /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields** — Get resource custom fields · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/customFieldsAll.md)
- **GET /vault/connections/{unified_api}/{service_id}/{resource}/custom-mappings** — List connection custom mappings · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionCustomMappingsAll.md)
- **GET /vault/authorize/{service_id}/{application_id}** — Authorize · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsAuthorize.md)
- **GET /vault/revoke/{service_id}/{application_id}** — Revoke connection · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsRevoke.md)
- **GET /vault/callback** — Callback · [markdown](https://developers.apideck.com/md/apis/vault/reference/connections/connectionsCallback.md)

### Custom Mappings

Full resource: [https://developers.apideck.com/md/apis/vault/reference/custom-mappings.md](https://developers.apideck.com/md/apis/vault/reference/custom-mappings.md)

- **GET /vault/custom-mappings/{unified_api}/{service_id}/{target_field_id}** — Get custom mapping · [markdown](https://developers.apideck.com/md/apis/vault/reference/custom-mappings/customMappingsOne.md)
- **POST /vault/custom-mappings/{unified_api}/{service_id}/{target_field_id}** — Create custom mapping · [markdown](https://developers.apideck.com/md/apis/vault/reference/custom-mappings/customMappingsAdd.md)
- **DELETE /vault/custom-mappings/{unified_api}/{service_id}/{target_field_id}** — Deletes a custom mapping · [markdown](https://developers.apideck.com/md/apis/vault/reference/custom-mappings/customMappingsDelete.md)
- **PATCH /vault/custom-mappings/{unified_api}/{service_id}/{target_field_id}** — Update custom mapping · [markdown](https://developers.apideck.com/md/apis/vault/reference/custom-mappings/customMappingsUpdate.md)
- **GET /vault/custom-mappings/{unified_api}/{service_id}** — List custom mappings · [markdown](https://developers.apideck.com/md/apis/vault/reference/custom-mappings/customMappingsAll.md)

### Sessions

Full resource: [https://developers.apideck.com/md/apis/vault/reference/sessions.md](https://developers.apideck.com/md/apis/vault/reference/sessions.md)

- **POST /vault/sessions** — Create Session · [markdown](https://developers.apideck.com/md/apis/vault/reference/sessions/sessionsCreate.md)

### Logs

Full resource: [https://developers.apideck.com/md/apis/vault/reference/logs.md](https://developers.apideck.com/md/apis/vault/reference/logs.md)

- **GET /vault/logs** — Get all consumer request logs · [markdown](https://developers.apideck.com/md/apis/vault/reference/logs/logsAll.md)