Records

Use VisaFlo IDs

Each successful create returns a VisaFlo record ID. Save it and use it for later file uploads, task creation, notes, status updates, and lookups. caseId is a VisaFlo record ID. It is not the human-readable caseNumber displayed in the dashboard.

Leads

Create a Lead

POST /api/public/lead/create

Field	Required	Description
`firstName`	Yes	Lead’s first name.
`email`	Yes	Lead email.
`lastName`, `phone`, `countryOfResidence`, `address`	No	Contact details.
`stage`, `source`, `caseType`, `primaryInterest`, `languagePreference`	No	Lead panel fields. Stage, source and case type accept an ID or a label.
`quotedProfessionalFee`, `consultationTime`, `estimatedCloseDate`, `wonDate`, `assigneeIds`	No	Booking and ownership fields.
`customFields`	No	Extra key/value pairs from your integration.

{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane@example.com",
  "phone": "+16135550100",
  "stage": "Consultation Booked",
  "consultationTime": "2026-10-01 14:30",
  "customFields": { "consultationDuration": "60 minutes" }
}

If the workspace already has an open lead for the email, this call updates it and returns 200 instead of 201. Stage and booking fields are replaced, while source, assignees and contact details only fill blanks. See Create a lead for the full rules and formats.

Search Leads

GET /api/public/lead/search Pass at least one of email (exact match) or name (name prefix). Use it to read a lead’s ID and status. You don’t need it before lead/create, which matches by email itself.

Clients

Create a Client

POST /api/public/client/create

Field	Required	Description
`firstName`	Yes	Client’s first name.
`email`	Yes	Client email.
`lastName`	No	Client’s last name.
`phone`	No	Phone number.

Search Clients

GET /api/public/client/search Pass email for an exact match or name for a name prefix. A search response includes the record values needed to decide whether to reuse the client.

Cases

Create a Case

POST /api/public/case/create Case payloads vary by case type. Use the VisaFlo case-type payload format from Settings > API Settings when configuring a new case integration. Persist the returned case ID before making follow-on requests.

Find a Case

GET /api/public/case/search Provide at least one query parameter:

Parameter	Match type
`caseId`	Exact VisaFlo record ID.
`caseNumber`	Exact human-readable file/application number.
`clientEmail`	Exact client email.

When you provide more than one parameter, VisaFlo applies all filters.

curl "https://api.vflo.app/api/public/case/search?clientEmail=jane@example.com" \
  -H "X-API-Key: YOUR_API_KEY"

Read or Update a Case

Method	Endpoint	Purpose
`GET`	`/api/public/case/:caseId`	Get a case with its client and assignees.
`PATCH`	`/api/public/case/:caseId/status`	Update the case status.

Start here

Leads

Clients

Cases

Files and forms

Tasks

Notes

Workflows

Use VisaFlo IDs

Leads

Create a Lead

Search Leads

Clients

Create a Client

Search Clients

Cases

Create a Case

Find a Case

Read or Update a Case

​Use VisaFlo IDs

​Leads

​Create a Lead

​Search Leads

​Clients

​Create a Client

​Search Clients

​Cases

​Create a Case

​Find a Case

​Read or Update a Case

Use VisaFlo IDs

Leads

Create a Lead

Search Leads

Clients

Create a Client

Search Clients

Cases

Create a Case

Find a Case

Read or Update a Case