Jump to Content

Guides API Reference

API Reference Guides

API Reference

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
Merge Fields
Sending in Leads
IDX Integration
Webhooks
Embedded Apps
Follow Up Bot
Common Issues
Support and Help

Events

/eventsget
/eventspost
/events/:idget

People

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

People Relationships

/peopleRelationshipsget
/peopleRelationshipspost
/peopleRelationships/:idget
/peopleRelationships/:idput
/peopleRelationships/:iddelete

Identity

/identityget

Notes

/notespost
/notes/:idget
/notes/:idput
/notes/:iddelete

Calls

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

Text Messages

/textMessagesget
/textMessagespost
/textMessages/:idget

Users

/usersget
/users/:idget
/users/:iddelete
/meget

Smart Lists

/smartListsget
/smartLists/:idget

Action Plans

/actionPlansget
/actionPlansPeopleget
/actionPlansPeoplepost
/actionPlansPeople/:idput

Email Templates

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

Text Message Templates

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

Email Marketing

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

Custom Fields

/customFieldsget
/customFieldspost
/customFields/:idget
/customFields/:idput
/customFields/:iddelete

Stages

/stagesget
/stagespost
/stages/:idget
/stages/:idput
/stages/:iddelete

Tasks

/tasksget
/taskspost
/tasks/:idget
/tasks/:idput
/tasks/:iddelete

Appointments

/appointmentsget
/appointmentspost
/appointments/:idget
/appointments/:idput
/appointments/:iddelete

Appointment Types

/appointmentTypesget
/appointmentTypespost
/appointmentTypes/:idget
/appointmentTypes/:idput
/appointmentTypes/:iddelete

Appointment Outcomes

/appointmentOutcomesget
/appointmentOutcomespost
/appointmentOutcomes/:idget
/appointmentOutcomes/:idput
/appointmentOutcomes/:iddelete

Webhooks

/webhooksget
/webhookspost
/webhooks/:idget
/webhooks/:idput
/webhooks/:iddelete

Webhook Events

/webhookEvents/:idget

Pipelines

/pipelinesget
/pipelinespost
/pipelines/:idget
/pipelines/:idput
/pipelines/:iddelete

Deals

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

Deals Custom Fields

/dealCustomFieldsget
/dealCustomFieldspost
/dealCustomFields/:idget
/dealCustomFields/:idput
/dealCustomFields/:iddelete

Groups

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

Teams

/teamsget
/teamspost
/teams/:idget
/teams/:idput
/teams/:iddelete

Team Inboxes

/teamInboxesget

Ponds

/pondsget
/pondspost
/ponds/:idget
/ponds/:idput
/ponds/:iddelete

Inbox Apps

Inbox Apps
Add Messagepost
Update Messageput
Add Notepost
Update Conversationput
Get Participantsget
Add Participantpost
Remove Participantdelete
Install Inbox Apppost
Deactivate Inbox Appdelete

Reactions

Reactions
/reactions/:idget
/reactions/:refType/:refIdpost
/reactions/:refType/:refIddelete

Threaded Replies

Threaded Replies
/threadedReplies/:idget

timeframes

/timeframesget

Support and Help

Need help with using our API? Have questions about how to build an integration with us?

Email us at [email protected] and we'll be happy to assist!