Follow Up Boss API Documentation
This is the complete API documentation for connecting to the Follow Up Boss API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Follow Up Boss: Manage real estate leads, tasks, appointments, and communication. Keep reading to get started.
Quickstart
Before you run your first Follow Up Boss request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Follow Up Boss connection — create or choose one in Connections. Note its
connectionId.
Every Follow Up Boss action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/followUpBossV2/latest/actions/{actionSlug}You need a MindCloud API Key and a Follow Up Boss connection. Then call an action such as Get Current User:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/followUpBossV2/latest/actions/get-current-user" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Follow Up Boss account. See Follow Up Boss API Authentication for the full flow and how to get your connection credentials.
Follow Up Boss actions
All 24 published actions for this Follow Up Boss version. Each page documents the endpoint, arguments, and response controls.
- GETCheck Duplicate Person
- POSTCreate Appointment
- POSTCreate Event
- POSTCreate Note
- POSTCreate Person
- POSTCreate Task
- GETGet Appointment
- GETGet Current User
- GETGet Event
- GETGet Note
- GETGet Person
- GETGet Task
- GETGet User
- GETList Appointments
- GETList Custom Fields
- GETList Events
- GETList People
- GETList Tasks
- GETList Unclaimed People
- GETList Users
- PUTUpdate Appointment
- PUTUpdate Note
- PUTUpdate Person
- PUTUpdate Task
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.