Testing with Filevine's API

You can test the API directly in the documentation. For more complex or extensive tests, you can download the JSON configuration and load it into your chosen API client to test.

Testing in the Documentation

Use the boxes on the right side of the documentation pages to test the API. 

Import Filevine API

Our documentation directly references our API CI/CD, meaning that it is automatically updating and improving over time. As such, to ensure that you’re testing with the most up-to-date version, you can download the JSON configuration and load it into your chosen API client.

Copy the JSON File

To copy the JSON file of Filevine API:

1. Go to the documentation page.
   For US users: https://developer.filevine.io/docs/v2-us/branches/main/31e991e1bfac1-filevine-api-v2
   For Canadian users: https://developer.filevine.io/docs/v2-ca/branches/main/31e991e1bfac1-filevine-api-v2 
2. Click Export, and select Original from the dropdown.
   
3. Open the downloaded file, view the raw data, and copy all of the text.
   

Import into Your API Client

Once you’ve copied the file, you can now import it into your API client. For example, if you are importing into Postman, you will:

1. In Postman, click Import.
2. Paste the text that you copied from the file. Postman will process it.
   
3. Import the file as a Postman collection.
   

Once it’s imported, you can see “Filevine API” in your Postman collection, consistent with the documentation’s organization.