This article reviews and answers common questions asked about Filevine’s API.
How are Changes to the API Communicated?
"Non-breaking" changes—changes that are additive, like adding "source":"button" to the payload—are not typically communicated.
"Breaking" changes—changes that alter how a user codes the API—are typically communicated through the What's New section in the developer documentation: https://developer.filevine.io/docs/v2/31e991e1bfac1-filevine-api-v2
What is the Rate Limit For API Requests?
The current rate limit for the majority of endpoints is 320 requests per endpoint per minute. This is not the case for billing endpoints and report endpoints:
- endpoints related to billing: 250 requests per endpoint per minute
- endpoints related to reports and project vitals: 5 requests per endpoint per minute
- endpoints related to Get Folder List: 50 requests per minute
Rate limits are per key, not per endpoint, unless the endpoint has a lower rate limit. For example, if you call three different endpoints, the collective rate limit is 320 requests per key per minute, unless one of the endpoints has a lower limit.
Can You Run a DocGen?
Currently, you cannot run a DocGen using API, as there isn’t an endpoint for this function. Because the Document Generation functionality would run a report for each API call, rate limiting and timeouts would be highly likely.
Instead, you can use Mass Doc Generation, which allows you to generate the same document across multiple projects. Learn more about Mass Doc Generation.
Can I Update an Obsolete Field?
Yes, the API can be used to update obsolete fields. You can leave them marked as obsolete.
To remove an obsolete field from your section, you can update the field using NULL and then remove the field from the template in Filevine.
How Do I Update Custom Contact Data?
First, get the tab IDs and custom fields. You can use the "Get Custom Contacts Metadata" API to get the custom tab IDs and custom data fields or "Get Custom Contact Tab" API to search by contact ID.
- Get Custom Contacts Metadata: https://developer.filevine.io/docs/v2-us/4f13e0319ab87-get-contact-metadata
- Get Custom Contact Tab: https://developer.filevine.io/docs/v2-us/d4c35f916bc5c-get-custom-contact-tab
Next, to update a custom field (ex.dateOfIncident), you must format the body as such:
"selector": "custom.dateOfIncident",
"action": "UPDATE",
"value"; "2024-01-01"
Note: You must use "custom." at the beginning of the selector name.
Please note that you cannot update a custom contact date field to a value that is not a valid date, meaning you cannot clear the value or set it to “NULL.”
Comments
0 comments
Article is closed for comments.