Skip to main content

Creating Custom API Requests in Filevine-Zapier

David Goodman
Updated

The Filevine-Zapier connector does not currently support every endpoint available in the Filevine API. However, you can manually access these “missing” endpoints using the “API Request (Beta)” action, which automatically handles authentication with your Personal Access Token (PAT) — no need to set up headers (like Org ID and User ID) manually.

🔸 You also do not need to handle authentication by sending requests to Filevine's identify endpoint. The custom "API Request (Beta)" action does all of this for you. You only need to specify the URL, HTTP method, query parameters, and body data for a request.

Follow the steps below to add and configure a custom API request using PATs in your Zap. 

 

📖 In this article:

 

See the Other Examples section for examples of other custom API requests you can create:

  1. Creating a Note in the Activity Feed for a Project
  2. Creating a Task for a Member in a Project
  3. Searching for Contacts by Multiple Criteria/Fields in Filevine
  4. Uploading and Fetching Documents in Filevine
  5. Creating a Calendar Appointment for a Project
  6. Add a Team Member to a Project
  7. Add a Team to a Project
  8. Add a Hashtag to a Project
  9. Add/Remove a Hashtag from a Contact
  10. Execute Taskflow Button in a Filevine Section
  11. Reset Taskflow Button in a Filevine Section


➕ Step 1: Add the "API Request (Beta)" Action to Your Zap

  1. Add a new step where you’d like to call a Filevine endpoint by pressing the + (Add Step) button in your Zap.

  2. In the app selection dialog, type Filevine.

  3. For Action Event, choose API Request (Beta).

  4. Under Account, click Select, and choose the Filevine connection you previously authorized using a PAT.

  5. Click Continue to move to the Setup tab.



 


⚙️ Step 2: Configure Your API Request

 

In the Configure tab, fill out the required fields based on the endpoint you are calling. Refer to the Filevine API documentation for endpoint-specific details.

 

Required Fields:

  • Stop on Error:

    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).

    • Choose “No” if you want to handle errors manually in later steps (see Filter step below).

  • HTTP Method: Choose the appropriate method (GET, POST, PATCH, etc.) for your endpoint.

  • Endpoint URL:

    Enter the full path including the base URL and endpoint path, e.g. https://api.filevineapp.com/fv-app/v2/projects/<Project ID>/chaindates/<Chain Date ID>/update -- replacing dynamic path parameters with values from previous steps.

  • Query String Parameters: Add any required key-value pairs here (optional, usually used with GET requests).

  • Additional Request Headers:

    ❌ Leave blank — the connector auto-handles headers like x-fv-orgid, x-fv-userid, and Authorization.

  • Body (for POST/PATCH):

    Provide a valid JSON object if the endpoint requires input. Example:

{
    "ChainDateTypeID": "<Chain Date Type ID>",
    "DueDate": "<Deadline Due Date>"
}

 

 
🧪 Step 3: Test the API Request

  1. Navigate to the Test tab.

  2. Click Test step (or Retest step if applicable).

  3. The API call will be made to Filevine:

    • Check the “Data in” tab to confirm the input values sent to the endpoint (see screenshot below on the left side).

  • Check the “Data out” tab to view the API response (see screenshot below on the right side).

🔍 Note:

Use these tabs to debug any issues — match your payload against the API documentation to verify required fields and formatting.

 



 


🔎 Optional: Add a Filter Step (If “Stop on Error” is Set to “No”)

If you chose “No” for “Stop on Error”, add a Filter step after the API Request to ensure the Zap only continues on success.

  • Set the filter condition to:

    Only continue if: Response Status → (Text) Exactly matches → 200

This ensures the Zap doesn’t proceed if the API request fails. You can also use a "Paths" step or the "Add error handler" feature to check the Response Status and perform additional actions if a request fails.

 

 

 


⌛ Legacy: Creating Custom API Requests with the Prior Authentication Method (without PATs) for Filevine-Zapier v2.4.6

If you have not upgraded to the new version of the Filevine-Zapier connector that supports PATs (v3.x) and are still using the legacy authentication method with an API key/secret, the instructions for using the custom "API Request (Beta)" action outlined above will still apply. However, the endpoint URL is assembled differently.

 

Instead of using the endpoints as listed in the Filevine API documentation (eg.https://api.filevineapp.com/fv-app/v2/...), you will want to include your Org tenant URL prefix and use the /zapier/core for the path, eg: https://sandbox.api.filevineapp.com/zapier/core/... Thus if your Org tenant URL prefix is: MYORG, then the endpoint URL would begin with: https://MYORG.api.filevineapp.com/zapier/core/...

Here is an example of making a PATCH call to the Filevine endpoint for Project chain deadline due date via the old API for the sandbox Org:

 

 

 

💡Other Examples:
 

Currently, the Filevine-Zapier connector does not have a built-in action for all Filevine API endpoints (although many new actions are planned on the development roadmap for 2025). To circumvent this limitation, you can use a custom "API Request (Beta)" action. The following sections demonstrate examples of different requests you can send to Filevine.

A. Creating a Note in the Activity Feed For a Project

To write a note and update the Activity Feed for a project, use the Create Note endpoint in Filevine with the following settings:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: POST
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/Notes
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body:
    Provide a valid JSON object in the format required by the endpoint documentation (https://developer.filevine.io/docs/v2-us/da00bc90e087f-create-note) paying special attention to the fields and objects that marked in red as "required". The following example is for creating a time entry note that is not marked IsBillable or IsChargable  (be sure to replace <REPLACE WITH YOUR -------> with the correct value or a variable from an earlier step):
     
{
  "ProjectId" : {"Native": <REPLACE WITH YOUR PROJECT ID>},
  "Body": "This is an example of a note in the project activity feed at: {{zap_meta_human_now}}",
  "Subject": "Example of new project note",
  "CreatedAt": "{{zap_meta_est_iso}}"
}

Note: the Subject field seems to be ignored by the "Create Note" endpoint. However, you can use the "Update Note" endpoint to set the Subject after it has been created.
 

There are many more fields that can be specified for the "Create Note" endpoint. Below is an example of a body with additional fields specified as a phone call type note ("phcall"), and includes the TimeEntry field:

{
  "ProjectId" : {"Native": <REPLACE WITH YOUR PROJECT ID>},
  "TypeTag": "phcall",
  "IsUnread": false,
  "IsCompleted": false,
  "Body": "This is an example of a phone call note in the project activity feed at: {{zap_meta_human_now}}",
  "Subject": "Example of new project note",
  "CreatedAt": "{{zap_meta_est_iso}}",
  "IsEdited": false,
  "IsLoaded": false,
  "CanBeShared": true,
  "TimeEntry": {
    "OrgID": <REPLACE WITH YOUR ORG ID>,
    "ProjectID": <REPLACE WITH YOUR PROJECT ID>,
    "Hours": 0,
    "IsBillable": false,
    "IsChargeable": false,
    "Date": "{{zap_meta_est_iso}}",
    "CreateDate": "{{zap_meta_est_iso}}",
    "IsDraft": false,
    "CanBeEdited": false
  }
}

Note: The TypeTag field can have several values, such as: "phcall", "task", or "note", but the Filevine API will ignore the TypeTag field with a value of "sms", and it will default to the "task" type, which is the same as a regular note.
 

The image below shows a custom "API Request (Beta)" action that uses the "Create Note" endpoint with only the top portion of the Configure tab displayed, and the body field (shown in the code examples above) is not shown in the screenshot.


 

B. Creating a Task for a Member in a Project

To add a task to the Activity Feed in a project, use the Create Task endpoint in Filevine, with the custom "API Request (Beta)" action settings outlined below.

🔸 Note that as of 8/28/2025, there appears to be a bug in the Filevine API where the targetDate field is ignored by Filevine, and the current date is used instead. Please follow the instructions for creating a second request to "Change Task Due Date" below.

  • Stop on Error: "Yes" (Recommended).

    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).

    • Choose “No” if you want to handle errors manually in later steps (see Filter step below).

  • HTTP Method: POST

  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/tasks 

  • Query String Parameters: ❌ Leave blank

  • Additional Request Headers: ❌ Leave blank

  • Body:
    Provide a valid JSON object in the format required by the endpoint documentation (https://developer.filevine.io/docs/v2-us/d4952175a619e-create-task) paying special attention to the fields and objects that marked in red as "required" in the top level of the request body. The following example is for creating a new task in a project that has a due date set for 7 days from the task creation date--note that the targetDate field mentioned in the Filevine documentation is currently not useable, and you should instead add the task shortcut syntax, eg. *05/11/2025, at the end of the body to set the due date. Also, be sure to replace <REPLACE WITH YOUR -------> with the correct value or a variable from an earlier step. 

    {
      "projectId": {
        "native": <REPLACE WITH YOUR PROJECT ID>,
      },
      "assigneeId": {
        "native": <REPLACE WITH ASSIGNED MEMBER ID>
      },
      "typeTag": "task",
      "isUnread": false,
      "isCompleted": false,
      "body": "This is an example of a task. Due: *in 7 days",
      "subject": "Example of a new project task",
      "isEdited": false,
      "allowEditing": false,
      "isLoaded": true,
      "canBeShared": true
    }


2nd Request for Setting the Task Due Date: Next, you will need to send a PUT request to the "Change Task Due Date" endpoint in order to set the due date for the task, since the Filevine API is currently ignored the targetDate field. Create another custom "API Request (Beta)" step with the following settings, and be sure to use the noteId.native field from the previous step as the "<Task ID>" in the endpoint URL path:

  • Stop on Error: "Yes" (Recommended).

  • HTTP Method: PUT

  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/tasks/<Task ID>/snooze -- replacing dynamic path parameter for the "<Task ID>" with the value from previous step.

  • Query String Parameters: ❌ Leave blank

  • Additional Request Headers: ❌ Leave blank

  • Body:
    Provide the desired due/target date for the new task by setting the snoozeDate field:

    {
      "snoozeDate": "2026-08-28T00:00:00Z"
    }

 

C. Searching for Contacts by Multiple Criteria/Fields in Filevine

You can use the “API Request (Beta)” action to call Filevine’s Get Contact List endpoint and pass in multiple search parameters like fullName, email, or phone. Please see the following article for instructions:

Searching for Contacts by Multiple Criteria/Fields in Filevine

 

D. Uploading and Fetching Documents in Filevine

You can use several “API Request (Beta)” actions to call Filevine’s document endpoints and upload a file to a project. Please see the following article for instructions:

Uploading and Fetching Documents in Filevine

 

E. Creating a Calendar Appointment for a Project

To create a calendar appointment associated with a project, use the Create Project Appointment endpoint in Filevine with the following settings:

  • Stop on Error: "Yes" (Recommended).

    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).

    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).

  • HTTP Method: POST

  • Endpoint URL:
    Enter the full path including the base URL and endpoint path, e.g. https://api.filevineapp.com/fv-app/v2/projects/<Project ID>/appointments -- replacing dynamic path parameters (ie. <Project ID>) with values from previous steps.

  • Query String Parameters: ❌ Leave blank

  • Additional Request Headers: ❌ Leave blank

  • Body:
    Provide a valid JSON object in the format required by the endpoint documentation (https://developer.filevine.io/docs/v2-us/8d2f454a014d1-create-project-appointment). The following example is for creating a calendar appointment that starts at "2025-10-26T15:00:00.000Z" and ends at "2025-10-26T16:00:00.000Z", which are UTC times. (Be sure to replace <REPLACE WITH YOUR -------> with the correct value or a variable from an earlier step) : 

    {
      "attendees": [{
        "userId": {"native": <REPLACE WITH YOUR ATTENDEE USER ID>},
        "optional": false
      }],
      "allDay": false,
      "ownerId": {"native": <REPLACE WITH YOUR USER ID>},
      "startUtc": "2025-10-26T15:00:00.000Z",
      "endUtc": "2025-10-26T16:00:00.000Z",
      "title": "testing meeting appt",
      "editable": true,
      "startEditable": true,
      "durationEditable": true,
      "calendarEventType": "Appointment",
      "projectId": {
        "native": "<REPLACE WITH YOUR PROJECT ID>"
      },
      "location": "https://zoom.us/j/55555555?omn=5555&jst=2",
      "notes": "Notes 1234 test!"
    }

    Note: The ownerId is optional and will default to the Zapier service account user if not set.

     


 

F. Add a Team Member to a Project

To add a team member to a project, use the Add Project Team Member endpoint in Filevine with the following settings:

{
    "UserId": {
        "Native": <REPLACE WITH USER ID>
    },
    "Username": "<REPLACE WITH USERNAME>",
    "IsAdmin": true,
    "Level": "Guest"
}

Note: when the Level field is set to "Guest", the user will not be following the project and thus will not receive notifications, unless the "Follower" Level is specified instead. When a member is added to a project and they are not a member of any team assigned to the project, then the new member will show up under "Unassigned Members" in the: Team > Teams tab in the project.

 

G. Add a Team to a Project

To add a team to a project, use the Adds a team to a project endpoint in Filevine with the following settings:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: POST
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/teams/<Team ID>/projects/<Project ID> -- replacing the <Team ID> and the <Project ID> with a static/hardcoded value or a dynamic value from a previous step
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body: ❌ Leave blank
     

H. Add a Hashtag to a Project

To add a hashtag to a project, use the Add Hashtag To Projects endpoint in Filevine with the following settings:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: POST
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/hashtags/<Hashtag> -- replacing <Hashtag> with the new or existing Filevine hashtag you want to add to the project
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body:
    Provide a valid JSON object in the format required by the endpoint documentation (https://filevine.stoplight.io/docs/v2-us/01475e26e8f3d-add-hashtag-to-projects), and be sure to replace <Project ID> with the ID of the Filevine project from a previous step that you want to add the tag to.
     
{
    "Projects": [
        {
            "Native": <Project ID>
        }
    ]
}

Note: You can add a tag to more than one project, and you can also tag other things like: Docs, Notes, and Comments by modifying the JSON body above.
 

I. Add/Remove a Hashtag from a Contact

To add/remove a hashtag from a contact, use the Update Custom Contact endpoint in Filevine with the following settings:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: POST
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/hashtags/<Hashtag> -- replacing <Hashtag> with the new or existing Filevine Tag you want to add to the project
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body:
    Provide a valid JSON object in the format required by the endpoint documentation (https://filevine.stoplight.io/docs/v2-us/87805ab1c7116-update-custom-contact), and be sure to replace #Do-Not-Market with the hashtag you want to add, and change REMOVE  to ADD if you want to add a hashtag instead.
     
[
    {
        "action":"REMOVE",
        "selector":"hashtags",
        "value":"#Do-Not-Market"
    }
]

Note: To get more info on how to use this endpoint, please create a custom API GET call to the Get Contact Metadate endpoint to see what else you can do.


 

J. Execute Taskflow Button in a Filevine Section

To execute/trigger a taskflow button in a section, you can use the following settings in a custom "API Request (Beta)" action:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: PUT
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/projects/<Project ID>/forms/<Section Selector>/TaskflowButtons/<Button Selector>  -- replacing the <Project ID> with a value from a previous step, and the <Section Selector> and <Button Selector> with a similarly dynamic or hard-coded value
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body:
    Provide a valid JSON object in the following format (currently undocumented in the Filevine API):
     
{
    "isTriggered": true
}

 

K. Reset Taskflow Button in a Filevine Section

To reset/clear a taskflow button in a section, you can use the following settings in a custom "API Request (Beta)" action:

  • Stop on Error: "Yes" (Recommended).
    • Select “Yes” to halt the Zap if an error occurs (recommended for most users).
    • Choose “No” if you want to handle errors manually in later steps (see Filter step note above).
  • HTTP Method: DELETE
  • Endpoint URL: https://api.filevineapp.com/fv-app/v2/projects/<Project ID>/forms/<Section Selector>/TaskflowButtons/<Button Selector>  -- replacing the <Project ID> with a value from a previous step, and the <Section Selector> and <Button Selector> with a similarly dynamic or hard-coded value
  • Query String Parameters: ❌ Leave blank
  • Additional Request Headers: ❌ Leave blank
  • Body: ❌ Leave blank

 

Looking For More Examples?

Please contact us at support@vineskills.com if there is an example of a custom request that you would like to see added here or if you need help building your Filevine integration in Zapier.

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk