Follow Up Boss API Reference

https://docs.followupboss.com/reference
Admin
Follow Up Boss provides a simple REST API that allows developers to integrate their applications and...
Tokens:166,009
Snippets:745
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Response Examples

Source: https://docs.followupboss.com/reference/peoplerelationships-post

Example JSON values for 200 and 400 response codes.

```json
"examples": {
                  "Result": {
                    "value": "{}"
                  }
                }
```

--------------------------------

### POST /inboxApps/install

Source: https://docs.followupboss.com/reference/inbox-apps-install

Installs your Inbox App for an account.

```APIDOC
## POST /inboxApps/install

### Description
Installs your Inbox App for an account.

### Method
POST

### Endpoint
/inboxApps/install

### Request Body
- **publishedInboxAppId** (integer) - Required - Your Published Inbox App ID.
- **userId** (integer) - Required - The User ID to scope the Inbox App to, or 0 for account-wide scope.
- **subscriptionUrl** (string) - Required - The webhook URL you will receive Inbox App replies at.

### Request Example
{
  "publishedInboxAppId": 1,
  "userId": 1,
  "subscriptionUrl": "https://example.com/webhook"
}

### Response
#### Success Response (201)
- **id** (integer) - The ID of the installed app.
- **created** (string) - Creation timestamp.
- **updated** (string) - Last updated timestamp.
- **createdById** (integer) - ID of the user who created the installation.
- **updatedById** (integer) - ID of the user who last updated the installation.
- **status** (integer) - Status code of the installation.
- **name** (string) - Name of the Inbox App.
- **publishedInboxAppId** (integer) - The ID of the published app.
- **userId** (integer) - The user ID scope.
- **canReply** (boolean) - Whether the app can reply.

#### Response Example
{
    "id": 1,
    "created": "2024-01-01T12:00:00Z",
    "updated": "2024-01-01T12:00:00Z",
    "createdById": 1,
    "updatedById": 1,
    "status": 10,
    "name": "Example Inbox App",
    "publishedInboxAppId": 1,
    "userId": 1,
    "canReply": true
}
```

--------------------------------

### Error Response Example

Source: https://docs.followupboss.com/reference/inbox-apps-add-note

Example of a 400 Bad Request response returned when the request body is missing.

```json
{
	"errorMessage": "body is required."
}
```

--------------------------------

### GET /stages

Source: https://docs.followupboss.com/reference/stages-get

Retrieve a list of stages.

```APIDOC
## GET /stages

### Description
Retrieve a list of stages.

### Method
GET

### Endpoint
/stages

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return. Max 100. Default: 10
- **offset** (integer) - Optional - Specifies the number of rows to skip before starting to return results. Default: 0
- **sort** (string) - Optional - Sorts the stages by `orderWeight`, `id` or `name`. Default: orderWeight

### Response
#### Success Response (200)
- **_metadata** (object) - Metadata about the collection.
- **stages** (array) - List of stage objects.

#### Response Example
{
  "_metadata": {
    "collection": "stages",
    "offset": 0,
    "limit": 20,
    "total": 8
  },
  "stages": [
    {
      "id": 1,
      "name": "Contact",
      "orderWeight": 1000,
      "isProtected": false,
      "peopleCount": 16
    }
  ]
}
```

--------------------------------

### GET /inboxApps/installedApps/{publishedInboxAppId}

Source: https://docs.followupboss.com/reference/view-inbox-app-installations

Lists Inbox App installation(s) and ID(s) for your Published Inbox App on the current FUB account.

```APIDOC
## GET /inboxApps/installedApps/{publishedInboxAppId}

### Description
Lists Inbox App installation(s) and ID(s) for your Published Inbox App on the current FUB account.

### Method
GET

### Endpoint
/inboxApps/installedApps/{publishedInboxAppId}

### Parameters
#### Path Parameters
- **publishedInboxAppId** (string) - Required - Your Published Inbox App ID, to display installations of.

### Response
#### Success Response (200)
- **inboxApps** (array) - List of installed inbox apps.
  - **inboxAppId** (integer) - The ID of the inbox app.
  - **userId** (integer) - The ID of the user.
  - **created** (string) - The creation timestamp.

#### Response Example
{
  "inboxApps": [
    {
      "inboxAppId": 1,
      "userId": 0,
      "created": "2025-01-01T12:12:12Z"
    },
    {
      "inboxAppId": 9,
      "userId": 5,
      "created": "2025-01-01T12:12:12Z"
    }
  ]
}
```

--------------------------------

### GET /deals/{id}

Source: https://docs.followupboss.com/reference/deals-id-get

Retrieve a deal by id.

```APIDOC
## GET /deals/{id}

### Description
Retrieve a deal by id.

### Method
GET

### Endpoint
/deals/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The id of the deal.

### Response
#### Success Response (200)
- **pipelineId** (integer) - The ID of the pipeline.
- **stageId** (integer) - The ID of the stage.
- **enteredStageAt** (string) - Timestamp when the deal entered the stage.
- **id** (integer) - The ID of the deal.
- **name** (string) - The name of the deal.
- **type** (integer) - The type of the deal.
- **status** (string) - The status of the deal.
- **price** (integer) - The price of the deal.
- **createdAt** (string) - Timestamp when the deal was created.
- **orderWeight** (integer) - The order weight of the deal.
- **description** (string) - Description of the deal.
- **projectedCloseDate** (object) - The projected close date.
- **people** (array) - List of people associated with the deal.
- **users** (array) - List of users associated with the deal.

#### Response Example
{
  "pipelineId": 100,
  "stageId": 16,
  "enteredStageAt": "2017-04-14T18:31:20Z",
  "id": 2146,
  "name": "adding deal",
  "type": 0,
  "status": "Active",
  "price": 216000,
  "createdAt": "2017-04-14T18:31:19Z",
  "orderWeight": 6000,
  "description": "A deal for an example",
  "projectedCloseDate": null,
  "people": [
    {
      "id": 10,
      "name": "Yolanda Smith",
      "avatar": ""
    }
  ],
  "users": [
    {
      "id": 1,
      "name": "John Smith"
    }
  ],
  "customField1": "A sample custom field.",
  "customField2": "2021-04-01T18:48:19Z",
  "customField3": 3,
  "customField4": "A sample dropdown selection.",
  "agentCommission": 50,
  "teamCommission": 50
}
```

--------------------------------

### GET /pipelines

Source: https://docs.followupboss.com/reference/pipelines-get

Search for pipelines. Optionally filter by name.

```APIDOC
## GET /pipelines

### Description
Search for pipelines. This endpoint allows you to retrieve a list of pipelines, optionally filtering by an exact name match.

### Method
GET

### Endpoint
/pipelines

### Parameters
#### Query Parameters
- **name** (string) - Optional - The pipeline name to lookup. (Must be an exact match.)

### Response
#### Success Response (200)
- **_metadata** (object) - Metadata about the collection.
- **pipelines** (array) - A list of pipeline objects.

#### Response Example
{
  "_metadata": {
    "collection": "pipelines",
    "offset": 0,
    "limit": 10,
    "total": 1
  },
  "pipelines": [
    {
      "id": 1,
      "name": "My Pipeline",
      "description": "A very cool pipeline",
      "orderWeight": 1000,
      "stages": [
        {
          "id": 10,
          "name": "Prospect",
          "description": "Prospective deals",
          "orderWeight": 1000
        },
        {
          "id": 11,
          "name": "In Progress",
          "description": "Deals in progress",
          "orderWeight": 2000
        }
      ]
    }
  ]
}
```

--------------------------------

### Deal JSON Example

Source: https://docs.followupboss.com/reference/deals-post

A sample JSON object representing a deal with various date, price, and custom fields.

```json
{
	"name": "Deal",
	"description": "A seller deal",
	"stageId": 1,
  "projectedCloseDate": "2022-01-27T05:00:00.000Z",
  "earnestMoneyDueDate": "2022-01-22T05:00:00.000Z",
  "mutualAcceptanceDate": "2022-01-23T05:00:00.000Z",
  "dueDiligenceDate": "2022-01-17T05:00:00.000Z",
  "finalWalkThroughDate": "2022-01-25T05:00:00.000Z",
  "possessionDate": "2022-01-27T05:00:00.000Z",
  "price": 30,
  "peopleIds": [
    2,
    5,
    6
  ],
  "userIds": [
    208,
    210
  ],
  "customField1": "A sample custom field.",
  "customField2": "2021-04-01T18:48:19Z",
  "customField3": 3,
  "customField4": "A sample dropdown selection.",  
  "agentCommission": 50,
  "teamCommission": 50
}
```

--------------------------------

### OpenAPI Definition for Get Participants

Source: https://docs.followupboss.com/reference/inbox-apps-get-participants

Contains the full OpenAPI specification for the endpoint, including security schemes, path parameters, and response examples.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.followupboss.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/inboxApps/{inboxAppId}/conversations/{extConversationId}/participants": {
      "get": {
        "summary": "Get Participants",
        "description": "Retrieves participants in an Inbox App conversation.",
        "operationId": "inbox-apps-get-participants",
        "parameters": [
          {
            "name": "inboxAppId",
            "in": "path",
            "description": "The Inbox App ID sending the message.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "extConversationId",
            "in": "path",
            "description": "The unique identifier that references the conversation you are updating.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n    {\n        \"id\": 1,\n        \"status\": \"active\",\n        \"userId\": null,\n        \"personId\": null,\n        \"name\": \"John Doe\",\n        \"phone\": \"+14075550123\",\n        \"email\": \"john@example.com\",\n        \"isAutomation\": false\n    },\n    {\n        \"id\": 2,\n        \"status\": \"active\",\n        \"userId\": 1,\n        \"personId\": null,\n        \"name\": null,\n        \"phone\": null,\n        \"email\": null,\n        \"isAutomation\": false\n    },\n    {\n        \"id\": 3,\n        \"status\": \"deleted\",\n        \"userId\": null,\n        \"personId\": 1,\n        \"name\": null,\n        \"phone\": null,\n        \"email\": null,\n        \"isAutomation\": false\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "example": 1,
                        "default": 0
                      },
                      "status": {
                        "type": "string",
                        "example": "active"
                      },
                      "userId": {},
                      "personId": {},
                      "name": {
                        "type": "string",
                        "example": "John Doe"
                      },
                      "phone": {
                        "type": "string",
                        "example": "+14075550123"
                      },
                      "email": {
                        "type": "string",
                        "example": "john@example.com"
                      },
                      "isAutomation": {
                        "type": "boolean",
                        "example": false,
                        "default": true
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"errorMessage\": \"externalConversationId is required.\"\n}"
                  }
                },
                "schema": {
                  "object": {
                    "properties": {
                      "errorMessage": {
                        "type": "string",
                        "example": "externalConversationId is required."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "58b53c341065f9c438aa1f7e:670c5a0ba3c2b0003ef32aef"
}
```

--------------------------------

### cURL Request for Rate Limits

Source: https://docs.followupboss.com/reference/rate-limit-limits-get

Example request using cURL to retrieve rate limit configurations, requiring X-System and X-System-Key headers.

```bash
curl --request GET \
     --url https://api.followupboss.com/v1/v1/rateLimit/limits \
     --header 'accept: application/json' \
     --header 'authorization: Basic ••••'
```

--------------------------------

### Text Message Schema Example

Source: https://docs.followupboss.com/reference/textmessages-id-get

Example values for text message properties including timestamps, boolean flags, and identifiers.

```json
"example": "2020-08-07T20:28:31Z"
}, "isIncoming": {
"type": "boolean",
"example": false,
"default": true
},
"archived": {
"type": "boolean",
"example": true,
"default": true
},
"read": {
"type": "boolean",
"example": true,
"default": true
},
"sharedInboxId": {
"type": "integer",
"example": 0,
"default": 0
},
"actionPlanId": {
"type": "integer",
"example": 0,
"default": 0
},
"groupTextId": {},
"isExternal": {
"type": "boolean",
"example": true,
"default": true
},
"externalUrl": {},
"externalLabel": {},
"systemId": {},
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"systemName": {}
```

--------------------------------

### Deal Update Response Example

Source: https://docs.followupboss.com/reference/deals-id-put

Represents a successful 200 OK response containing the updated deal object.

```json
{
	"name": "New Deal",
	"stageId": 2,
  "description": "The best deal",
  "projectedCloseDate": "2001-01-02",
	"earnestMoneyDueDate": "2001-01-01T05:00:00.000Z",
  "mutualAcceptanceDate": "2001-01-01T05:00:00.000Z",
  "dueDiligenceDate": "2001-01-01T05:00:00.000Z",
  "finalWalkThroughDate": "2001-01-01T05:00:00.000Z",
  "possessionDate": "2001-01-01T05:00:00.000Z",
  "price": 30,
  "peopleIds": [
    2,
    5,
    6
  ],
  "userIds": [
    208,
    210
  ],
  "customField1": "A sample custom field.",
  "customField2": "2021-04-01T18:48:19Z",
  "customField3": 3,
  "customField4": "A sample dropdown selection.",  
  "agentCommission": 50,
  "teamCommission": 50
}
```

--------------------------------

### OpenAPI Definition for View Installed Inbox Apps

Source: https://docs.followupboss.com/reference/view-inbox-app-installations

This OpenAPI specification defines the endpoint for retrieving installed Inbox Apps, including the required path parameter and response structures.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.followupboss.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/inboxApps/installedApps/{publishedInboxAppId}": {
      "get": {
        "summary": "View Installed Inbox Apps",
        "description": "Lists Inbox App installation(s) and ID(s) for your Published Inbox App on the current FUB account.",
        "operationId": "view-inbox-app-installations",
        "parameters": [
          {
            "name": "publishedInboxAppId",
            "in": "path",
            "description": "Your Published Inbox App ID, to display installations of.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"inboxApps\": [\n    {\n      \"inboxAppId\": 1,\n      \"userId\": 0,\n      \"created\": \"2025-01-01T12:12:12Z\"\n    },\n    {\n      \"inboxAppId\": 9,\n      \"userId\": 5,\n      \"created\": \"2025-01-01T12:12:12Z\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "inboxApps": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "inboxAppId": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "userId": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "created": {
                            "type": "string",
                            "example": "2025-01-01T12:12:12Z"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errorMessage\": \"You do not have permission to view installations for this Published Inbox App.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorMessage": {
                      "type": "string",
                      "example": "You do not have permission to view installations for this Published Inbox App."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "58b53c341065f9c438aa1f7e:68f7ec91ed0a88b8511809a8"
}
```

--------------------------------

### POST /pipelines

Source: https://docs.followupboss.com/reference/pipelines-post

Creates a new pipeline with specified stages and configuration.

```APIDOC
## POST /pipelines

### Description
Creates a new pipeline in the system.

### Method
POST

### Endpoint
/pipelines

### Request Body
- **name** (string) - Required - The name of the pipeline.
- **description** (string) - Optional - A description for the pipeline.
- **orderWeight** (integer) - Optional - The display order weight of the pipeline (default: 0).
- **stages** (array) - Optional - A list of stages within the pipeline.
  - **name** (string) - Required - Name of the stage.
  - **description** (string) - Optional - Description of the stage.
  - **orderWeight** (integer) - Optional - Display order weight of the stage (default: 0).
  - **color** (string) - Optional - Hex color code for the stage.
  - **closedStage** (boolean) - Optional - Whether the stage is considered closed (default: true).

### Request Example
{
  "name": "Buyer pipeline",
  "description": "A pipeline for buyers",
  "orderWeight": 1000,
  "stages": [
    {
      "name": "First Stage",
      "description": "",
      "orderWeight": 1000,
      "color": "#FFFFFF",
      "closedStage": false
    }
  ]
}

### Response
#### Error Response (400)
- **Result** (object) - Returns an empty object on failure.
```

--------------------------------

### POST /pipelines

Source: https://docs.followupboss.com/reference/pipelines-post

Add a new pipeline to the system. Requires owner permissions.

```APIDOC
## POST /pipelines

### Description
Add a pipeline. Only the owner has access to create and modify pipelines.

### Method
POST

### Endpoint
/pipelines

### Request Body
- **name** (string) - Required - Name of the pipeline.
- **description** (string) - Optional - Description of the pipeline.
- **stages** (array) - Optional - An array of stage objects that should be associated with the pipeline.
- **orderWeight** (integer) - Optional - Set this value to enforce a specific sort order.

### Request Example
{
  "name": "Buyer pipeline",
  "description": "A pipeline for buyers",
  "orderWeight": 1000,
  "stages": [
    {
      "name": "First Stage",
      "description": "",
      "orderWeight": 1000,
      "color": "#FFFFFF",
      "closedStage": false
    },
    {
      "name": "Second Stage",
      "description": "",
      "orderWeight": 2000,
      "closedStage": true
    }
  ]
}

### Response
#### Success Response (200)
- **name** (string) - Name of the pipeline.
- **description** (string) - Description of the pipeline.
- **orderWeight** (integer) - Sort order value.
- **stages** (array) - List of stages associated with the pipeline.
```

--------------------------------

### cURL Request Example

Source: https://docs.followupboss.com/reference/rate-limit-usage-get

A cURL command to retrieve rate limit usage data, requiring Basic authentication headers.

```bash
curl --request GET \
     --url https://api.followupboss.com/v1/v1/rateLimit/usage \
     --header 'accept: application/json' \
     --header 'authorization: Basic ••••'
```

--------------------------------

### Appointment JSON Response Example

Source: https://docs.followupboss.com/reference/appointments-post

Represents a typical JSON response object for an appointment, including details about invitees, timing, and metadata.

```json
{
   "id":13854,
   "created":"2020-09-04T15:13:18Z",
   "updated":"2020-09-04T15:13:18Z",
   "createdById":1,
   "updatedById":1,
   "title":"Lunch",
   "description":"Tom and John Q. are having lunch. Gotta try the new \"impossible\" burger",
   "start":"2020-09-04T16:00:00Z",
   "end":"2020-09-04T17:00:00Z",
   "allDay":false,
   "originFub":true,
   "location":"",
   "invitees":[
      {
         "userId":1,
         "personId":null,
         "name":"Tom Minch",
         "email":"tom@example.com",
         "picture":"https://placekitten.com/408/287"
      },
      {
         "userId":null,
         "personId":44673,
         "name":"John Q Customer",
         "email":"johnq@example.com"
      }
   ],
   "typeId": null,
   "type": null,
   "outcomeId": null,
   "outcome": null,
   "externalEventLink":null,
   "externalCalendarId":null,
   "isEditable":true,
   "detailsVisible":true
}
```

--------------------------------

### GET /timeframes

Source: https://docs.followupboss.com/reference/timeframes-get

Retrieves a list of all available timeframes.

```APIDOC
## GET /timeframes

### Description
Get a list of timeframes.

### Method
GET

### Endpoint
/timeframes

### Response
#### Success Response (200)
- **_metadata** (object) - Metadata about the collection.
- **timeframes** (array) - A list of timeframe objects.

#### Response Example
{
    "_metadata": {
        "collection": "timeframes",
        "offset": 0,
        "limit": 10,
        "total": 0,
        "next": null,
        "nextLink": null
    },
    "timeframes": [
        {
            "id": 1,
            "timeframe": "0-3 Months"
        },
        {
            "id": 2,
            "timeframe": "3-6 Months"
        },
        {
            "id": 3,
            "timeframe": "6-12 Months"
        },
        {
            "id": 4,
            "timeframe": "12+ Months"
        },
        {
            "id": 5,
            "timeframe": "No Plans"
        }
    ]
}
```

--------------------------------

### Example JSON Response

Source: https://docs.followupboss.com/reference/rate-limit-usage-get

A sample JSON response showing the structure of usage data, including total requests, rate-limited counts, and current account limits.

```json
{
  "system": "your-system",
  "period": "last_24h",
  "usage": {
    "total_requests": 1247,
    "rate_limited_requests": 23,
    "rate_limit_percentage": 1.84,
    "peak_hour": "2026-05-19T14:00:00Z",
    "current_limits": {
      "across_all_accounts": { "default": 750, "GET.people": 100 },
      "per_account": { "default": 25 }
    }
  }
}
```

--------------------------------

### GET /personAttachments/{id}

Source: https://docs.followupboss.com/reference/personattachments-id-get

Retrieve an attachment by ID.

```APIDOC
## GET /personAttachments/{id}

### Description
Retrieve an attachment by ID.

### Method
GET

### Endpoint
/personAttachments/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of the attachment.

#### Header Parameters
- **X-System** (string) - Required - Registered system name.
- **X-System-Key** (string) - Required - Registered system API key.

### Response
#### Success Response (200)
- **personId** (integer) - ID of the person associated with the attachment.
- **fileName** (string) - Name of the file.
- **fileSize** (object) - Size of the file.
- **id** (integer) - ID of the attachment.
- **mimeType** (string) - MIME type of the attachment.
- **uri** (string) - URI of the attachment.
- **thumbnailUri** (object) - URI of the thumbnail.
- **status** (string) - Status of the attachment.
- **createdAt** (string) - Creation timestamp.
- **createdById** (integer) - ID of the user who created the attachment.
- **createdByName** (string) - Name of the user who created the attachment.
- **is_external** (integer) - Flag indicating if the attachment is external.
- **system_id** (integer) - ID of the system.

#### Response Example
{
    "personId": 1,
    "fileName": "test.jpg",
    "fileSize": null,
    "id": 2,
    "mimeType": "link",
    "uri": "https://test.com/myfile",
    "thumbnailUri": null,
    "status": "created",
    "createdAt": "2022-11-16T03:44:52Z",
    "createdById": 1,
    "createdByName": "Olivia Admin",
    "is_external": 1,
    "system_id": 123
}
```

--------------------------------

### Example JSON Response

Source: https://docs.followupboss.com/reference/rate-limit-limits-get

The structure of the response body containing system name and current rate limit configurations.

```json
{
  "system": "your-system",
  "current_limits": {
    "across_all_accounts": { "default": 750, "GET.people": 100 },
    "per_account": { "default": 25 }
  }
}
```

--------------------------------

### GET /pipelines/{id}

Source: https://docs.followupboss.com/reference/pipelines-id-get

Retrieve a pipeline by id.

```APIDOC
## GET /pipelines/{id}

### Description
Retrieve a pipeline by id.

### Method
GET

### Endpoint
/pipelines/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The id of the pipeline.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the pipeline.
- **name** (string) - The name of the pipeline.
- **description** (string) - A description of the pipeline.
- **orderWeight** (integer) - The order weight of the pipeline.
- **stages** (array) - A list of stages within the pipeline.

#### Response Example
{
  "id": 1,
  "name": "Contact Pipeline",
  "description": "A pipeline for contacts",
  "orderWeight": 1000,
  "stages": [
    {
      "id": 1,
      "name": "Contact",
      "description": "",
      "orderWeight": 3000,
      "color": "#FFFFFF"
    },
    {
      "id": 2,
      "name": "Lead",
      "description": "",
      "orderWeight": 4000,
      "color": ""
    }
  ]
}
```

--------------------------------

### GET /groups/:id

Source: https://docs.followupboss.com/reference/groups-id-get

Retrieve a group by id.

```APIDOC
## GET /groups/:id

### Description
Retrieve a group by id.

### Method
GET

### Endpoint
/groups/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the group.

### Accessibility Restrictions
This is not accessible by lender accounts.
```

--------------------------------

### Property Inquiry JSON Example

Source: https://docs.followupboss.com/reference/events-post

A sample JSON payload representing a property inquiry event, including person details, property information, and search criteria.

```json
{
  "source": "Zillow",
  "system": "Zillow",
  "type": "Property Inquiry",
  "message": "I am interested in 6825 Mulholland Dr, ...",
  "description": "Move-in: 12/28/2013",
  "person": {
    "id": 1234,
    "firstName": "Melissa ",
    "lastName": "Hartman",
    "emails": [
      {
        "value": "m.hartman@example.com",
        "type": "home"
      }
    ],
    "phones": [
      {
        "value": "(555) 555-1234",
        "type": "home"
      }
    ],
    "tags": [
      "Lease option"
    ],
    "sourceUrl": "http://click.email.zillow.com/?qs=1e120cec11e3",
    "customBirthday": "2/16/1990"
  },
  "property": {
    "street": "6825 Mulholland Dr",
    "city": "Los Angeles",
    "state": "CA",
    "code": "90068",
    "mlsNumber": "14729339",
    "price": "310000",
    "forRent": "0",
    "url": "http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/",
    "type": "Residential"
  },
  "propertySearch": {
    "type": "Lot",
    "neighborhood": "Cahuenga Pass",
    "city": "Los Angeles",
    "state": "CA",
    "code": "90068",
    "minPrice": 100000,
    "maxPrice": 500000
  }
}
```

--------------------------------

### POST /actionPlansPeople

Source: https://docs.followupboss.com/reference/actionplanspeople-post

Apply an Action Plan to a person.

```APIDOC
## POST /actionPlansPeople

### Description
Apply an Action Plan to a person.

### Method
POST

### Endpoint
/actionPlansPeople

### Parameters
#### Request Body
- **personId** (integer) - Required - The ID of the person to whom you would like to apply the action plan.
- **actionPlanId** (integer) - Required - The ID of the action plan to apply

### Request Example
{
  "personId": 123,
  "actionPlanId": 456
}

### Response
#### Success Response (200)
- **(object)** - Empty object indicating success.

#### Response Example
{
}
```

--------------------------------

### GET /automations/{id}

Source: https://docs.followupboss.com/reference/automationsid

Retrieve an Automation by ID.

```APIDOC
## GET /automations/{id}

### Description
Retrieve an Automation by ID.

### Method
GET

### Endpoint
/automations/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of the Automation to retrieve

### Response
#### Success Response (200)
- **object** - Automation details

#### Response Example
{
  "example": "{}"
}
```

--------------------------------

### GET /appointments/:id

Source: https://docs.followupboss.com/reference/appointments-id-get

Retrieve an appointment by id.

```APIDOC
## GET /appointments/:id

### Description
Retrieve an appointment by id.

### Method
GET

### Endpoint
https://api.followupboss.com/v1/appointments/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - The id of the appointment.

### Response
#### Success Response (200)
- 200 - Success

#### Error Response (400)
- 400 - Bad Request
```

--------------------------------

### GET /textMessages/:id

Source: https://docs.followupboss.com/reference/textmessages-id-get

Retrieve a text message by id.

```APIDOC
## GET /textMessages/{id}

### Description
Retrieve a text message by id.

### Method
GET

### Endpoint
/textMessages/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The id of the text message record.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the text message.
- **created** (string) - Creation timestamp.
- **updated** (string) - Last update timestamp.
- **createdById** (integer) - ID of the user who created the message.
- **updatedById** (integer) - ID of the user who last updated the message.
- **personId** (integer) - ID of the associated person.
- **name** (string) - Full name of the person.
- **firstName** (string) - First name of the person.
- **lastName** (string) - Last name of the person.
- **picture** (object) - Picture data.
- **userId** (integer) - ID of the associated user.
- **userName** (string) - Name of the associated user.
- **status** (string) - Status of the message.
- **message** (string) - The content of the message.
- **fromNumber** (string) - The sender's phone number.
- **toNumber** (string) - The recipient's phone number.

#### Response Example
{
    "id": 752,
    "created": "2020-08-07T20:28:31Z",
    "updated": "2020-08-07T20:28:31Z",
    "createdById": 1,
    "updatedById": 1,
    "personId": 1,
    "name": "William Riker",
    "firstName": "William",
    "lastName": "Riker",
    "picture": null,
    "userId": 1,
    "userName": "Tom Minch",
    "status": "Sent",
    "message": "Content is hidden for privacy reasons.",
    "fromNumber": "8885551234",
    "toNumber": "8885559876"
}
```

--------------------------------

### Webhook Success Response Example

Source: https://docs.followupboss.com/reference/webhooks-post

Represents the successful creation of a webhook with its associated ID, status, event type, and callback URL.

```json
{
  "id": 1004,
  "status": "Active",
	"event": "peopleCreated",
  "url": "https://acmeLeadProvider.com/callbacks/followupboss/peopleCreated"
}
```

--------------------------------

### POST /stages

Source: https://docs.followupboss.com/reference/stages-post

Creates a new stage. You can optionally provide an orderWeight to influence the sorting of the stage relative to others.

```APIDOC
## POST /stages

### Description
Create a new stage.

### Method
POST

### Endpoint
/stages

### Request Body
- **name** (string) - Required - Name of the stage.
- **orderWeight** (integer) - Optional - Set this value to enforce a specific sort order. Default: 1000.

### Request Example
{
  "name": "Pending",
  "orderWeight": 7000
}

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the stage.
- **name** (string) - The name of the stage.
- **orderWeight** (integer) - The sort order weight of the stage.
- **isProtected** (boolean) - Indicates if the stage is protected.
- **peopleCount** (integer) - The number of people in this stage.

#### Response Example
{
  "id": 7,
  "name": "Pending",
  "orderWeight": 7000,
  "isProtected": false,
  "peopleCount": 10
}
```

--------------------------------

### GET /teams/{id}

Source: https://docs.followupboss.com/reference/teams-id-get

Retrieves a team by its unique ID.

```APIDOC
## GET /teams/{id}

### Description
Get a team by id.

### Method
GET

### Endpoint
https://api.followupboss.com/v1/teams/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The team id.

### Response
#### Success Response (200)
- **200** - Successful retrieval of team data.
```

--------------------------------

### POST /groups

Source: https://docs.followupboss.com/reference/groups-post

Creates a new group with the specified configuration.

```APIDOC
## POST /groups

### Description
Create a new group.

### Method
POST

### Endpoint
/groups

### Parameters
#### Request Body
- **name** (string) - Required - The name of the group.
- **distribution** (string) - Optional - The distribution model to utilize. (Note: Lender groups cannot be set to `first-to-claim`.) Default: round-robin. Enum: [first-to-claim, round-robin]
- **users** (array) - Required - An array of user IDs that will be members of this group.
- **type** (string) - Optional - `Agent` groups allow admins and agents and `Lender` groups allow lender role users. Default: Agent. Enum: [Agent, Lender]
- **claimWindow** (integer) - Optional - Number of seconds to allow someone to claim a lead in a first-to-claim group before reassigning. Default: 1800.
- **defaultGroupId** (integer) - Optional - The ID of the group to assign unclaimed first-to-claim leads to after the claim window expires.
- **defaultPondId** (integer) - Optional - The ID of the pond to assign unclaimed first-to-claim leads to after the claim window expires.
- **defaultUserId** (integer) - Optional - The ID of the user to assign unclaimed first-to-claim leads to after the claim window expires.

### Response
#### Success Response (201)
- **id** (integer) - The ID of the created group.
- **name** (string) - The name of the group.
- **type** (string) - The type of the group.
- **distribution** (string) - The distribution model.
- **users** (array) - List of user objects assigned to the group.
```

--------------------------------

### GET /tasks/:id

Source: https://docs.followupboss.com/reference/tasks-id-get

Retrieves a task by its unique ID.

```APIDOC
## GET /tasks/:id

### Description
Get a task by id.

### Method
GET

### Endpoint
https://api.followupboss.com/v1/tasks/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - The ID of the task to get.

### Response
#### Success Response (200)
- 200 OK
```

--------------------------------

### POST /appointments

Source: https://docs.followupboss.com/reference/appointments-post

Create a new appointment in the system.

```APIDOC
## POST /appointments

### Description
Create an appointment.

### Method
POST

### Endpoint
/appointments

### Parameters
#### Query Parameters
- **sendInvitation** (boolean) - Optional - Send an invitation email to invitees. (Note: If the "appointment reminders" is enabled, an SMS reminder will also be sent.)

#### Request Body
- **title** (string) - Required - Title of the appointment.
- **description** (string) - Optional - Description of the appointment or event.
- **invitees** (string) - Optional - Array of users and/or people to invite to the appointment.
- **allDay** (boolean) - Optional - Sets whether the appointment is an all day event or not.
- **start** (string) - Required - The beginning date and time of the appointment (in UTC, also supports time zone suffix).
- **end** (string) - Required - The ending date and time of the appointment (in UTC, also supports time zone suffix).
- **location** (string) - Optional - The location or address of the appointment.
- **createdById** (integer) - Optional - The id of the user that created the appointment. (Note: This can only be set by admins, otherwise the currently logged in user's ID is used.)
- **typeId** (integer) - Optional - The Follow Up Boss appointment type identifier.
- **outcomeId** (integer) - Optional - The Follow Up Boss appointment outcome identifier.
```

--------------------------------

### GET /smartLists/{id}

Source: https://docs.followupboss.com/reference/smartlist-id-get

Retrieve a Smart List by id.

```APIDOC
## GET /smartLists/{id}

### Description
Retrieve a Smart List by id.

### Method
GET

### Endpoint
https://api.followupboss.com/v1/smartLists/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - The ID of the Smart List.

### Response
#### Success Response (200)
```

--------------------------------

### GET /people

Source: https://docs.followupboss.com/reference/people-get

Retrieves a list of people records from the collection.

```APIDOC
## GET /people

### Description
Retrieves a paginated list of people records.

### Method
GET

### Endpoint
/people

### Response
#### Success Response (200)
- **_metadata** (object) - Metadata about the collection including offset, limit, and total count.
- **people** (array) - A list of person objects.

#### Response Example
{
  "_metadata": {
    "collection": "people",
    "offset": 0,
    "limit": 10,
    "total": 35
  },
  "people": [
    {
      "id": 10763,
      "name": "Tom Minch",
      "firstName": "Tom",
      "lastName": "Minch",
      "stage": "Lead"
    }
  ]
}
```
Tokens:
Raw