API Errors Q&A

Scroll down for error code specific troubleshooting options.

All Errors

1. Check that the API Credentials (key/secret or PAT) being used are valid. Due to shard and Org migrations, it may be wise to create new credentials
2. Make sure the Filevine Integration user is an Org Admin and a project admin.
3. Ensure "https://" is in the base URL.
4. Make sure the base URL is correct. The base URL can be found in the API Credentials tool.
   

400-Bad Request

This error can happen when a default field for a template is NULL. If you receive this request, confirm that the URL format is correct.

401-Unauthorized

This error means that the credentials provided are not correct or valid. 

Check the API credentials being used. Due to shard/Org migration, it may be wise to create new credentials.

403-Forbidden Error

API is formatted correctly but the integration user is not permitted to complete the action.

1. Check that the API Credentials being used are valid. Due to shard/org migrations, it may be wise to create new credentials.
2. Make sure the Filevine Integration user is an Org Admin and is set to be auto-added to all projects.
3. Ensure "https://" is in the base URL.
4. Add the "User-Agent" header to your call. This header identifies the application responsible for making the HTTP request.

Your IP may be blocked by our firewall. As of December 2024, we are working on updating our firewall settings to permit anonymized IPs—learn more.

404 Not Found Error

1. Validate that your base URL is correct for your API operation using our API documentation.
2. Check to see if the section selector in your URL matches the section selector in the Customs Editor.
3. Verify that the field selector(s) in the body of your request match the field selector(s) in Customs Editor.

429-Rate Limit Exceeded

Learn more about rate limits.

If you see this error, you could be making too many calls in a minute or exceeding the rate limit.

500-System error

This error could mean that a FV Integration user is not an Org Admin or is not on all the projects as an Admin.

When calling a POST or a PATCH on a form or collection, why does it return a 200 but not update or insert all the data?

At this time, the API doesn't return an error if the data is not in the proper format or valid value. Please ensure that the values you are passing in are valid for the type of field and data type. 

Our general recommendations:

1. Check the Customs Editor to determine the type of field you are populating or updating.
2. Run a GET call on the form or collection to see other similar fields and values in the section.

Why do I get a 200 response when I try to remove a team from a project but the team remains on the project?

If you are trying to remove a team, and the PAT user is on the team as an Admin, then the team cannot be removed from the project. This limitation prevents the API from leaving the project in a state where it cannot be accessed using the PAT. 

Instead, you can move the PAT user to a different team, unassign them from the team you're trying to remove, and then execute the Remove Team From Project endpoint.

Why am I missing results in my response?

If you expected more than 50 results, but only received 50, you can verify if more results could have been displayed by referencing the hasMore: boolean value in your response. If this value is true, you’ll need to paginate your calls.

The response also provides you with link references, including the next page:

"links": {

"self": "/projects/11733434/team?name=&email=&username=&searchterm=&offset=0&limit=50&requestedFields=",

"prev": null,

"next": "/projects/11733434/team?name=&email=&username=&searchterm=&offset=50&limit=50&requestedFields="

}

If you paste the "next" value right after your base value, it'll bring you to the second/next page.

Additionally, you can configure the call’s limit to meet your needs. The default limit per page is 50, but the maximum allowed is 1000. For example: /projects?offset=0&limit=1000

Why Didn’t my Primary Permissions Update go Through?

Approaching things like this with the API can be troublesome. Because of this, we do have in-house admin tools to transfer primary role ownership on all projects that meet a certain criteria using our reporting functionality.

For departing employees, you can also use the Task Utility Tool to ensure that removing the user does not orphan any data.

If you still require updating the first primary through the API:

1. Perform this call to validate current role assignments and gather user ID's: https://filevine.stoplight.io/docs/v2-us/4c9193e500341-get-project-team-org-roles-with-members-and-positions
2. Verify you have the correct Primary role using this call: https://filevine.stoplight.io/docs/v2-us/8c66f60f07a69-get-project-org-roles
3. Perform a PUT /fv-app/v2/projects/{projectId}/team/users/{userId}/roles call and insert the Role ID you found (with the key "OrgRoleId") utilizing the MakeFirst field which allows you to specify if you'd like the user to be the "First" Position for the "Primary" role. Here's an example request body:

   { "Roles": [ { "OrgRoleId": { "Native": ROLEIDGOESHERE}, "MakeFirst": true } ] }

Why Can't I Create a Project via API When Using the PAT Authentication Method?

Make sure that the user associated with your PAT has the "Project Creation" permission enabled under Advanced Access Tab (Setup > Orgs > Advanced Access).