About the Vault API


Veeva Vault provides a simple, powerful, and secure API (application programming interface) that allows software programmers to write scripts and programs to interact and integrate with Veeva Vault. Using Veeva Vault API, your organization can build tools to import, update, and retrieve documents or object records. Veeva Vault API respects all the same business and access control roles as the Vault UI.

The API can be used to develop custom applications, integrations, or higher level tools such as data loaders for schema visualization.

Developers can consult the Veeva Vault Developer Portal for reference information and details on using the API.

About API Transaction Limits

Vault limits the number of API calls that can be made every 5 minutes (burst) and every 24 hours (daily). When either of these limits are reached, the API returns an API_LIMIT_EXCEEDED error message and no further API calls to the vault will be processed until the next 5 minute or 24 hour period begins. The limits are per-vault.

  • The default burst limit is 1,000 or 2,000 calls, depending on your vault.
  • The default daily limit is 100,000 calls.

Viewing API Transaction Limits & Counts

Each API call made to your vault (Create, Retrieve, Update, or Delete) is counted in both the Daily API Count and Burst API Count.

To view this information, go to Admin > Settings > General Settings.

  • Daily API Count: The number of API calls made in the past 24 hours and the total number allowed. This does not reset daily; it’s continually updated over a rolling 24 hour period.
  • Burst API Count: The number of API calls made in the past 5 minutes and the total number allowed. This is reset every 5 minutes.

API Information and Daily Transaction Limits

About API Transaction Limit Notifications

When the vault reaches the warning threshold for the daily limit or reaches the burst limit, Vault sends a notification email to all users who elected to receive System Availability notifications through their user profile.

Setting API Limit Warning Thresholds

You can set warning thresholds (50%, 75%, 90%) on the daily API count from Admin > Settings > General Settings.

API Transaction Limit Notification Templates

The following standard message templates are available for API transaction limit notifications: 

  • dailyAPILimitWarningEmail__v - When a warning threshold is set on the Daily Limit, this message notifies users that they have reached 50%, 75%, or 90% of the limit.
  • dailyAPILimitExceededEmail__v - When the Daily Limit is reached, this message notifies users that no further API calls can be processed until the next 24 hour cycle.
  • burstAPILimitExceededEmail__v - When the Burst Limit is reached, this message notifies users that no further API calls will be processed until the next 24 hour cycle.

If needed, you can update the text of the standard message templates above to match your internal processes. In the message template token selector, the following API transaction limit tokens are available:

  • {$DailyAPILimitPercent} - The 24 hour threshold (50%, 75%, or 90% of the limit) after which a notification email is sent.
  • {$DailyAPILimit} - The number of API calls that can be made every 24 hours.
  • {$DailyAPICount} - The number of API calls that have been made in the past 24 hours.
  • {$BurstAPILimit} - The number of API calls that can be made every 5 minutes.
  • {$BurstAPICount} - The number of API calls that have been made in the past 5 minutes.