Jump to Content

Guides API Reference

v1.0

API Reference Guides

API Reference

v1.0

Documentation

Getting Started with Follow Up Boss
API Terms of Use
Registration and Identification
Authentication and Authorization
Requests and Responses
Error Responses
Searching
Pagination
Rate Limiting
Common Filters and Parameters
Merge Fields
Sending in Leads
IDX Integration
Webhooks
Embedded Apps
Follow Up Bot
Common Issues
API Change Requests
Support and Help

Events

/eventsget
/eventspost
/events/:idget

People

/peopleget
/peoplepost
/people/:idget
/people/:idput
/people/:iddel
/people/checkDuplicateget
/people/unclaimedget
/people/claimpost
/people/ignoreUnclaimedpost
/personAttachmentspost
/personAttachments/:idget
/personAttachments/:idput
/personAttachments/:iddel

People Relationships

/peopleRelationshipsget
/peopleRelationshipspost
/peopleRelationships/:idget
/peopleRelationships/:idput
/peopleRelationships/:iddel

Identity

/identityget

Notes

/notespost
/notes/:idget
/notes/:idput
/notes/:iddel

Calls

/callsget
/callspost
/calls/:idget
/calls/:idput

Text Messages

/textMessagesget
/textMessagespost
/textMessages/:idget

Users

/usersget
/users/:idget
/users/:iddel
/meget

Smart Lists

/smartListsget
/smartLists/:idget

Action Plans

/actionPlansget
/actionPlansPeopleget
/actionPlansPeoplepost
/actionPlansPeople/:idput

Automations

/automationsget
/automations/:idget
/automationsPeopleget
/automationsPeople/:idget
/automationsPeoplepost
/automationsPeople/:idput

Email Templates

/templatesget
/templatespost
/templates/:idget
/templates/:idput
/templates/mergepost
/templates/:iddel

Text Message Templates

/textMessageTemplatesget
/textMessageTemplatespost
/textMessageTemplates/:idget
/textMessageTemplates/:idput
/textMessageTemplates/mergepost
/textMessageTemplates/:iddel

Email Marketing

/emEventsget
/emEventspost
/emCampaignsget
/emCampaignspost
/emCampaigns/:idput

Custom Fields

/customFieldsget
/customFieldspost
/customFields/:idget
/customFields/:idput
/customFields/:iddel

Stages

/stagesget
/stagespost
/stages/:idget
/stages/:idput
/stages/:iddel

Tasks

/tasksget
/taskspost
/tasks/:idget
/tasks/:idput
/tasks/:iddel

Appointments

/appointmentsget
/appointmentspost
/appointments/:idget
/appointments/:idput
/appointments/:iddel

Appointment Types

/appointmentTypesget
/appointmentTypespost
/appointmentTypes/:idget
/appointmentTypes/:idput
/appointmentTypes/:iddel

Appointment Outcomes

/appointmentOutcomesget
/appointmentOutcomespost
/appointmentOutcomes/:idget
/appointmentOutcomes/:idput
/appointmentOutcomes/:iddel

Webhooks

/webhooksget
/webhookspost
/webhooks/:idget
/webhooks/:idput
/webhooks/:iddel

Webhook Events

/webhookEvents/:idget

Pipelines

/pipelinesget
/pipelinespost
/pipelines/:idget
/pipelines/:idput
/pipelines/:iddel

Deals

/dealsget
/dealspost
/deals/:idget
/deals/:idput
/deals/:iddel
/dealAttachmentspost
/dealAttachments/:idget
/dealAttachments/:idput
/dealAttachments/:iddel

Deals Custom Fields

/dealCustomFieldsget
/dealCustomFieldspost
/dealCustomFields/:idget
/dealCustomFields/:idput
/dealCustomFields/:iddel

Groups

/groupsget
/groups/roundRobinget
/groupspost
/groups/:idget
/groups/:idput
/groups/:iddel

Teams

/teamsget
/teamspost
/teams/:idget
/teams/:idput
/teams/:iddel

Team Inboxes

/teamInboxesget

Ponds

/pondsget
/pondspost
/ponds/:idget
/ponds/:idput
/ponds/:iddel

Inbox Apps

Inbox Apps
Add Messagepost
Add System Confirmation Messagepost
Update Messageput
Add Notepost
Update Conversationput
Get Participantsget
Add Participantpost
Remove Participantdel
Install Inbox Apppost
Deactivate Inbox Appdel
View Installed Inbox Appsget

Reactions

Reactions
/reactions/:idget
/reactions/:refType/:refIdpost
/reactions/:refType/:refIddel

Threaded Replies

Threaded Replies
/threadedReplies/:idget

timeframes

/timeframesget

Powered by

API Change Requests

Are you an integration partner interested in seeing new API endpoints? Changes to existing endpoints?

Email us at [email protected] and our team will be in touch!

Updated about 14 hours ago

Updated about 14 hours ago