# Follow Up Boss

> Follow Up Boss real estate CRM - manage people, leads, deals, tasks, appointments and more.

Lets an agent read and manage your Follow Up Boss CRM - people (contacts and
leads), events, notes, tasks, appointments, calls, texts, deals and configuration.

## What it can do

| Method | What it does |
| --- | --- |
| `followupboss_get_identity` | Get the account and user tied to the API key (confirm credentials). |
| `followupboss_get_me` | Get the current user for the API key. |
| `followupboss_list_users` | List account users (agents). |
| `followupboss_get_user` | Get one user by id. |
| `followupboss_list_teams` | List teams. |
| `followupboss_get_team` | Get one team by id. |
| `followupboss_list_groups` | List groups. |
| `followupboss_get_group` | Get one group by id. |
| `followupboss_list_people` | Search / list people; filter by query, stage, source, tags, assignee. Use fields=allFields and the next cursor for deep paging. |
| `followupboss_get_person` | Get one person by id. |
| `followupboss_create_person` | Create a person (prefer create_event for new leads). |
| `followupboss_update_person` | Update a person. |
| `followupboss_delete_person` | Delete a person. |
| `followupboss_list_events` | List events (lead activity / inquiries). |
| `followupboss_get_event` | Get one event by id. |
| `followupboss_create_event` | Register a lead via an event - runs lead routing and action plans. |
| `followupboss_list_notes` | List notes; filter by person. |
| `followupboss_get_note` | Get one note by id. |
| `followupboss_create_note` | Add a note to a person. |
| `followupboss_update_note` | Update a note. |
| `followupboss_delete_note` | Delete a note. |
| `followupboss_list_tasks` | List tasks; filter by person, assignee, completion. |
| `followupboss_get_task` | Get one task by id. |
| `followupboss_create_task` | Create a task. |
| `followupboss_update_task` | Update a task (mark done with isCompleted). |
| `followupboss_delete_task` | Delete a task. |
| `followupboss_list_appointments` | List appointments; filter by person. |
| `followupboss_get_appointment` | Get one appointment by id. |
| `followupboss_create_appointment` | Create an appointment. |
| `followupboss_update_appointment` | Update an appointment. |
| `followupboss_delete_appointment` | Delete an appointment. |
| `followupboss_list_appointment_types` | List appointment types. |
| `followupboss_list_appointment_outcomes` | List appointment outcomes. |
| `followupboss_list_calls` | List logged calls; filter by person. |
| `followupboss_get_call` | Get one call by id. |
| `followupboss_create_call` | Log a call. |
| `followupboss_update_call` | Update a logged call. |
| `followupboss_list_text_messages` | List text messages; filter by person. |
| `followupboss_get_text_message` | Get one text message by id. |
| `followupboss_create_text_message` | Log a text message. |
| `followupboss_list_emails` | List emails; filter by person. |
| `followupboss_get_email` | Get one email by id. |
| `followupboss_list_email_templates` | List email templates. |
| `followupboss_list_text_message_templates` | List text message templates. |
| `followupboss_list_deals` | List deals; filter by stage, pipeline, person. |
| `followupboss_get_deal` | Get one deal by id. |
| `followupboss_create_deal` | Create a deal. |
| `followupboss_update_deal` | Update a deal (move it with a new stageId). |
| `followupboss_delete_deal` | Delete a deal. |
| `followupboss_list_pipelines` | List deal pipelines. |
| `followupboss_get_pipeline` | Get one pipeline by id. |
| `followupboss_list_stages` | List deal stages (find stageId for deals). |
| `followupboss_get_stage` | Get one stage by id. |
| `followupboss_list_smart_lists` | List smart lists (saved filtered views). |
| `followupboss_list_custom_fields` | List custom fields. |
| `followupboss_get_custom_field` | Get one custom field by id. |
| `followupboss_create_custom_field` | Create a custom field. |
| `followupboss_update_custom_field` | Update a custom field. |
| `followupboss_delete_custom_field` | Delete a custom field. |
| `followupboss_list_webhooks` | List webhooks. |
| `followupboss_get_webhook` | Get one webhook by id. |
| `followupboss_create_webhook` | Create a webhook subscription. |
| `followupboss_update_webhook` | Update a webhook. |
| `followupboss_delete_webhook` | Delete a webhook. |
| `followupboss_get_person_attachment` | Get one person attachment by id. |
| `followupboss_create_person_attachment` | Attach an externally hosted file to a person. |
| `followupboss_update_person_attachment` | Update a person attachment. |
| `followupboss_delete_person_attachment` | Delete a person attachment. |
| `followupboss_get_deal_attachment` | Get one deal attachment by id. |
| `followupboss_create_deal_attachment` | Attach an externally hosted file to a deal. |
| `followupboss_update_deal_attachment` | Update a deal attachment. |
| `followupboss_delete_deal_attachment` | Delete a deal attachment. |
| `followupboss_list_deal_custom_fields` | List deal custom fields (separate from person custom fields). |
| `followupboss_get_deal_custom_field` | Get one deal custom field by id. |
| `followupboss_create_deal_custom_field` | Create a deal custom field. |
| `followupboss_update_deal_custom_field` | Update a deal custom field. |
| `followupboss_delete_deal_custom_field` | Delete a deal custom field. |
| `followupboss_list_action_plans` | List action plans (automated lead-nurture sequences). |
| `followupboss_list_action_plans_people` | List action-plan-to-person assignments. |
| `followupboss_apply_action_plan` | Apply an action plan to a person. |
| `followupboss_update_action_plan_person` | Pause or resume an applied action plan (Paused / Running). |
| `followupboss_list_automations` | List automations. |
| `followupboss_get_automation` | Get one automation by id. |
| `followupboss_list_automations_people` | List automation-to-person pairings. |
| `followupboss_trigger_automation` | Manually trigger an automation for a person. |

## How to get credentials

The API uses HTTP Basic auth - your API key is the username and the password
is left blank. You must be an account admin to view it.

1. Open [app.followupboss.com/2/api](https://app.followupboss.com/2/api)
   (in the app: **Admin** -> **API**).
2. Copy your **API Key** (or create one if none exists).
3. Paste it into FlyMyAI as `FOLLOWUPBOSS_API_KEY`.

Each user in Follow Up Boss has their own key - actions are attributed to that
user, so use the key of the user the agent should act as.

## Fields to fill in FlyMyAI

| FlyMyAI field | Where it comes from |
| --- | --- |
| `FOLLOWUPBOSS_API_KEY` | Admin -> API ([app.followupboss.com/2/api](https://app.followupboss.com/2/api)) |

## Links

- [Get your API key](https://app.followupboss.com/2/api)
- [API reference](https://docs.followupboss.com/reference)