# Vault API API

> Vault API API on Apizie: 27 endpoints (Authorize, Callback, Get all connections, Get connection, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/dev-tools:apideck-vault/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:apideck-vault`
- Category: Dev Tools
- Status: byok
- Source: https://developers.apideck.com
- Page: https://apizie.tech/api/dev-tools/apideck-vault
- OpenAPI: https://apizie.tech/api/dev-tools/apideck-vault/openapi.json

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…

## Endpoints

### Authorize
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| service_id | string | yes | Service ID of the resource to return |
| application_id | string | yes | Application ID of the resource to return |
| state | string | yes | An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the… |
| redirect_uri | string | yes | URL to redirect back to after authorization. When left empty the default configured redirect uri will be used. |
| scope | array | no | One or more OAuth scopes to request from the connector. OAuth scopes control the set of resources and operations that are allowed after… |

### Callback
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| state | string | yes | An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the… |
| code | string | yes | An authorization code from the connector which Apideck Vault will later exchange for an access token. |

### Get all connections
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| api | string | no | Scope results to Unified API |
| configured | boolean | no | Scopes results to connections that have been configured or not |

### Get connection
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |

### Create connection
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connections-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |
| body | object | yes | JSON request body |

### Update connection
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connections-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |
| body | object | yes | JSON request body |

### Deletes a connection
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connections-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |

### Import connection
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connections-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |
| body | object | yes | JSON request body |

### Get Access Token
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connections-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |
| body | object | no | JSON request body |

### Get resource settings
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connection-settings-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| resource | string | yes | Name of the resource (plural) |

### Update settings
`POST https://apizie.tech/v1/dev-tools:apideck-vault/connection-settings-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| service_id | string | yes | Service ID of the resource to return |
| unified_api | string | yes | Unified API |
| resource | string | yes | Name of the resource (plural) |
| body | object | yes | JSON request body |

### Get resource custom fields
`GET https://apizie.tech/v1/dev-tools:apideck-vault/custom-fields-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| resource | string | yes | Name of the resource (plural) |

### Get resource example
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-example` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| resource | string | yes | Name of the resource (plural) |

### Get resource schema
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| resource | string | yes | Name of the resource (plural) |

### Get all consumers
`GET https://apizie.tech/v1/dev-tools:apideck-vault/consumers-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| cursor | string | no | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. |
| limit | integer | no | Number of results to return. Minimum 1, Maximum 200, Default 20 |

### Create consumer
`POST https://apizie.tech/v1/dev-tools:apideck-vault/consumers-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| body | object | yes | JSON request body |

### Get consumer
`GET https://apizie.tech/v1/dev-tools:apideck-vault/consumers-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| consumer_id | string | yes | ID of the consumer to return |

### Update consumer
`POST https://apizie.tech/v1/dev-tools:apideck-vault/consumers-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| consumer_id | string | yes | ID of the consumer to return |
| body | object | yes | JSON request body |

### Delete consumer
`POST https://apizie.tech/v1/dev-tools:apideck-vault/consumers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| consumer_id | string | yes | ID of the consumer to return |

### Consumer request counts
`GET https://apizie.tech/v1/dev-tools:apideck-vault/consumer-request-counts-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| consumer_id | string | yes | ID of the consumer to return |
| start_datetime | string | yes | Scopes results to requests that happened after datetime |
| end_datetime | string | yes | Scopes results to requests that happened before datetime |

### Get custom mapping
`GET https://apizie.tech/v1/dev-tools:apideck-vault/custom-mappings-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| target_field_id | string | yes | ID of the target field to return as a custom mapping. |

### Create custom mapping
`POST https://apizie.tech/v1/dev-tools:apideck-vault/custom-mappings-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| target_field_id | string | yes | ID of the target field to return as a custom mapping. |
| body | object | yes | JSON request body |

### Update custom mapping
`POST https://apizie.tech/v1/dev-tools:apideck-vault/custom-mappings-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| target_field_id | string | yes | ID of the target field to return as a custom mapping. |
| body | object | yes | JSON request body |

### Deletes a custom mapping
`POST https://apizie.tech/v1/dev-tools:apideck-vault/custom-mappings-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| unified_api | string | yes | Unified API |
| service_id | string | yes | Service ID of the resource to return |
| target_field_id | string | yes | ID of the target field to return as a custom mapping. |

### Get all consumer request logs
`GET https://apizie.tech/v1/dev-tools:apideck-vault/logs-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-app-id | string | yes | The ID of your Unify application |
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| filter | object | no | Filter results |
| cursor | string | no | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. |
| limit | integer | no | Number of results to return. Minimum 1, Maximum 200, Default 20 |

### Revoke connection
`GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-revoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| service_id | string | yes | Service ID of the resource to return |
| application_id | string | yes | Application ID of the resource to return |
| state | string | yes | An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the… |
| redirect_uri | string | yes | URL to redirect back to after authorization. When left empty the default configured redirect uri will be used. |

### Create Session
`POST https://apizie.tech/v1/dev-tools:apideck-vault/sessions-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | string | yes | ID of the consumer which you want to get or push data from |
| x-apideck-app-id | string | yes | The ID of your Unify application |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/dev-tools:apideck-vault/connections-authorize" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Vault API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/dev-tools:apideck-vault/connections-authorize with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Vault API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Vault API itself also needs your own key from apideck.com.

### Can AI agents use the Vault API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:apideck-vault.

### What is the status of the Vault API API?
Needs your own provider key (bring your own key)