# ExaVault API

> ExaVault API on Apizie: 59 endpoints (Get account settings, Update account settings, Get activity logs, Get webhook logs, …) returned as clean JSON through one API key. 59 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/cloud:exavault/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:exavault`
- Category: Cloud
- Status: live
- Source: https://exavault.com
- Page: https://zieapi.vercel.app/api/cloud/exavault
- OpenAPI: https://zieapi.vercel.app/api/cloud/exavault/openapi.json

ExaVaults API allows you to incorporate ExaVaults suite of file transfer and user management tools into your own application.\nExaVault supports both POST (recommended when requesting large data sets) and GET…

## Endpoints

### Get account settings
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required for the request |
| ev-access-token | string | yes | Access Token for the request |
| include | string | no | Related records to include in the response. Valid option is **masterUser** |

### Update account settings
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-account`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get activity logs
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-session-logs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| startDate | string | no | Start date of the filter data range |
| endDate | string | no | End date of the filter data range |
| ipAddress | string | no | Used to filter session logs by ip address. |
| username | string | no | Username used for filtering a list |
| path | string | no | Path used to filter records |
| type | string | no | Filter session logs for operation type (see table above for acceptable values) |
| offset | integer | no | Offset of the records list |
| limit | integer | no | Limit of the records list |
| sort | string | no | Comma separated list sort params |

### Get webhook logs
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-webhook-logs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| startDate | string | no | Earliest date of entries to include in list |
| endDate | string | no | Latest date of entries to include in list |
| endpointUrl | string | no | Webhook listener endpoint |
| event | string | no | Type of activity that triggered the webhook attempt |
| statusCode | integer | no | Response code from the webhook endpoint |
| resourcePath | string | no | Path of the resource that triggered the webhook attempt |
| username | string | no | Filter by triggering username. |
| offset | integer | no | Records to skip before returning results. |
| limit | integer | no | Limit of the records list |
| sort | string | no | Comma separated list sort params |

### Get all email groups
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-email-lists`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| include | string | no | Related record types to include in the response. Valid option is `ownerUser` |

### Create new email list
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-email-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get individual email group
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-email-list-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the email list to return. |
| include | string | no | Related record types to include in the response. Valid option is `ownerUser` |

### Update an email group
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-email-list-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the email list to update. |
| body | object | no | JSON request body |

### Delete an email group with given id
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-email-list-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the email list to delete |

### Send referral email to a given address
`POST https://zieapi.vercel.app/v1/cloud:exavault/send-referral-email`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Resend welcome email to specific user
`POST https://zieapi.vercel.app/v1/cloud:exavault/send-welcome-email`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| username | string | yes | A username to send the welcome email to. |

### Get receive folder form settings
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-form-by-share-hash`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access Token required to make the API call. |
| shareHash | string | yes | Share hash to retrieve the form for. |
| include | string | no | Related record types to include in the response. Valid option is **share** |

### Get form data entries for a receive
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-form-entries`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the form to retrieve entries for. |
| limit | integer | no | Limit of records to be returned (for pagination) |
| offset | integer | no | Current offset of records (for pagination) |

### Delete a receive form submission
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-form-message-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the entry to be deleted data for |

### Get receive folder form by Id
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-form-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Form unique ID number. |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access Token required to make the API call. |
| include | string | no | Enter "**share**" to get information about associated receive folder. |

### Updates a form with given parameters
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-form-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Form unique ID number. |
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get a list of notifications
`GET https://zieapi.vercel.app/v1/cloud:exavault/list-notifications`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| type | string | no | Type of notification include in the list. Valid options are **file**, **folder**, **send_receipt**, **share_receipt**, **file_drop** If… |
| offset | integer | no | Starting notification record in the result set. Can be used for pagination. |
| sort | string | no | What order the list of matches should be in. Valid sort fields are **resourcename**, **date**, **action** and **type**. The sort order for… |
| limit | integer | no | Number of notification records to return. Can be used for pagination. |
| include | string | no | Related records to include in the response. Valid options are **ownerUser**, **resource**, **share** |
| action | string | no | The kind of action which triggers the notification. Valid choices are **connect** (only for delivery receipts), **download**, **upload**,… |

### Create a new notification
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-notification`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get notification details
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-notification-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID. |
| include | string | no | Related record types to include in the response. You can include multiple types by separating them with commas. Valid options are… |

### Update a notification
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-notification-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID. |
| body | object | no | JSON request body |

### Delete a notification
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-notification-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the notification. Use [GET /notifications](#operation/listNotifications) if you need to lookup an ID. |

### Resend invitations to share recipients
`POST https://zieapi.vercel.app/v1/cloud:exavault/resend-invitations-for-share`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| shareId | integer | yes | ID of the share to resend invites for. |
| body | object | no | JSON request body |

### Get Resource Properties
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-resource-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| resource | string | yes | Resource identifier of the file or folder to get metadata for. |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,… |

### Create a folder
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-folder`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Delete Resources
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-resources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| body | object | no | JSON request body |

### Compress resources
`POST https://zieapi.vercel.app/v1/cloud:exavault/compress-files`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Copy resources
`POST https://zieapi.vercel.app/v1/cloud:exavault/copy-resources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Download a file
`GET https://zieapi.vercel.app/v1/cloud:exavault/download`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| resources[] | array | yes | Path of file or folder to be downloaded, starting from the root. Can also be an array of paths. |
| downloadArchiveName | string | no | When downloading multiple files, this will be used as the name of the zip file that is created. |

### Extract resources
`POST https://zieapi.vercel.app/v1/cloud:exavault/extract-files`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get a list of all resources
`GET https://zieapi.vercel.app/v1/cloud:exavault/list-resources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| resource | string | yes | Resource identifier to get resources for. Can be path/id/name. |
| sort | string | no | Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort… |
| offset | integer | no | Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. e.g, setting `offset=200` would… |
| limit | integer | no | The number of files to limit the result. If you have more files in your directory than this limit, make multiple calls, incrementing the… |
| type | string | no | Limit types of resources returned to "file" or "dir" only. This is ignored if you are using the `name` parameter to trigger a search. |
| name | string | no | Text to match resource names. This allows you to filter the results returned. For example, to locate only zip archive files, you can enter… |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,… |

### List contents of folder
`GET https://zieapi.vercel.app/v1/cloud:exavault/list-resource-contents`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| id | integer | yes | ID of the parent resource to get a list of resources for. |
| sort | string | no | Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort… |
| offset | integer | no | Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. |
| limit | integer | no | The number of files to limit the result. Cannot be set higher than 100. If you have more than one hundred files in your directory, make… |
| type | string | no | Limit types of resources returned to "file" or "dir" only. |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,… |

### Move resources
`POST https://zieapi.vercel.app/v1/cloud:exavault/move-resources`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Preview a file
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-preview-image`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| resource | string | yes | Resource identifier for the image file. |
| size | string | yes | The size of the image. |
| width | integer | no | Overrides sizes. Sets to a specific width. |
| height | integer | no | Overrides sizes. Sets to a specific height. |
| page | integer | no | Page number to extract from a multi-page document (0 is the first page). Vaild for **.pdf** or **.doc** files. |

### Upload a file
`POST https://zieapi.vercel.app/v1/cloud:exavault/upload-file`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| offsetBytes | integer | no | Allows a file upload to resume at a certain number of bytes. |
| path | string | yes | Destination path for the file being uploaded, including the file name. |
| fileSize | integer | yes | File size, in bits, of the file being uploaded. |
| resume | boolean | no | True if upload resume is supported, false if it isn't. |
| allowOverwrite | boolean | no | True if a file with the same name is found in the designated path, should be overwritten. False if different file names should be generated. |
| body | object | no | Form fields as a JSON object |

### Get resource metadata
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-resource-info-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID number of the resource |
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **share**, **notifications**, **directFile**,… |

### Rename a resource.
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-resource-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID number of the resource |
| ev-access-token | string | yes | Access token required to make the API call. |
| ev-api-key | string | yes | API key required to make the API call. |
| body | object | no | JSON request body |

### Delete a Resource
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-resource-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID number of the resource |
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Get a list of shares
`GET https://zieapi.vercel.app/v1/cloud:exavault/list-shares`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| offset | integer | no | Current offset of records (for pagination) |
| limit | integer | no | Limit of records to be returned (for pagination) |
| scope | string | no | Set of shares to return. (**all**=all of them, **active**=shares that are currently active, **curentUser**=shares created by you) |
| sort | string | no | What order the list of matches should be in. |
| type | string | no | Limit the list of matches to only certain types of shares. |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**. |
| name | string | no | When provided, only shares whose names include this value will be in the list. Supports wildcards, such as **send\*** to return everything… |
| recipient | string | no | Filter the results to include only shares that invited a certain email address. Supports wildcard matching so that **\*@example.com** will… |
| message | string | no | When provided, only shares with a message that contains the text will be included in the list of matches. Both the subject and the body of… |
| username | string | no | When provided, only shares created by the user with that `username` will be included in the list. Does not support wildcard searching. |
| search | string | no | Searches the share name, username, recipients, share messages fields for the provided value. Supports wildcard searches. |

### Creates a share
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-share`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Complete send files
`POST https://zieapi.vercel.app/v1/cloud:exavault/complete-direct-send`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| id | integer | yes | ID of the share to trigger invitations for. |

### Get a share
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-share-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the share entry |
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| include | string | no | Comma separated list of relationships to include in response. Possible values are **owner**, **resources**, **notifications**, **activity**. |

### Update a share
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-share-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the share entry |
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access Token |
| body | object | yes | JSON request body |

### Deactivate a share
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-share-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the share entry |
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Get metadata for a list of SSH Keys
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-sshkeys-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| userId | string | no | Only return results for the given user ID. This is not the username, but the numeric ID of the user. |
| limit | integer | no | Limits the results by the given number. Cannot be set higher than 100. |
| offset | integer | no | Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. |

### Create a new SSH Key
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-sshkey`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get metadata for an SSH Key
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-sshkey`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Delete an SSH Key
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-sshkey`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Get a list of users
`GET https://zieapi.vercel.app/v1/cloud:exavault/list-users`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| username | string | no | The username of the user you are looking for. Only entries with the same username as this will be in the list of results. Does not support… |
| homeResource | string | no | Resource identifier for user's home directory. Does not support wildcard searches. |
| nickname | string | no | Nickname to search for. Ignored if `username` is provided. Supports wildcard searches. |
| email | string | no | Email to search for. Ignored if `username` is provided. Supports wildcard searches |
| role | string | no | Types of users to include the list. Ignored if `username` is provided. Valid options are **admin**, **master** and **user** |
| status | integer | no | Whether a user is locked. Ignored if `username` is provided. **0** means user is locked, **1** means user is not locked. |
| search | string | no | Searches the nickname, email, role and homeDir fields for the provided value. Ignored if `username` is provided. Supports wildcard searches. |
| offset | integer | no | Starting user record in the result set. Can be used for pagination. |
| sort | string | no | Sort order or matching users. You can sort by multiple columns by separating sort options with a comma; the sort will be applied in the… |
| limit | integer | no | Number of users to return. Can be used for pagination. |
| include | string | no | Comma separated list of relationships to include in response. Valid options are **homeResource** and **ownerAccount**. |

### Create a user
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Get info for a user
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-user-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET… |
| ev-api-key | string | yes | API Key |
| ev-access-token | string | yes | Access token required to make the API call. |
| include | string | no | Comma-separated list of relationships to include in response. Possible values include **homeResource** and **ownerAccount**. |

### Update a user
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET… |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Delete a user
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-user`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the [GET… |
| ev-api-key | string | yes | API Key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Get Webhooks List
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-wehooks-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| include | string | no | List of related record types to include. Valid options are `owningAccount` and `resource` |
| offset | integer | no | Records to skip before returning results. |
| limit | integer | no | Limit of the records list |

### Add A New Webhook
`POST https://zieapi.vercel.app/v1/cloud:exavault/add-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Regenerate security token
`POST https://zieapi.vercel.app/v1/cloud:exavault/regenerate-webhook-token`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Webhook ID |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Resend a webhook message
`POST https://zieapi.vercel.app/v1/cloud:exavault/resend-webhook-activity-entry`

| Parameter | Type | Required | Description |
|---|---|---|---|
| activityId | string | yes | Webhooks activity entry ID |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

### Get info for a webhook
`GET https://zieapi.vercel.app/v1/cloud:exavault/get-webhook-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Webhook endpoint ID |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| include | string | no | Include metadata for related items; `ownerAccount` and/or `resource` |

### Update a webhook
`POST https://zieapi.vercel.app/v1/cloud:exavault/update-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Webhook endpoint ID |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |
| body | object | no | JSON request body |

### Delete a webhook
`POST https://zieapi.vercel.app/v1/cloud:exavault/delete-webhook`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Webhook endpoint ID |
| ev-api-key | string | yes | API key required to make the API call. |
| ev-access-token | string | yes | Access token required to make the API call. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:exavault/get-account" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the ExaVault API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:exavault/get-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the ExaVault API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the ExaVault API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:exavault.

### What is the status of the ExaVault API?
Live: works with just an Apizie key