---
agentTools:
  projectIndex: https://docs.followupboss.com/llms.txt
---

# /calls

Search for calls.

> 🚧 Restricted Results
>
> Some call data is not accessible via API and is only visible within the Follow Up Boss application.

> 📘 Person ID
>
> A `personId` may be sent or returned as `0`, which indicates that this is a call from an unknown person to a number associated to the Follow Up Boss account.

# OpenAPI definition

```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": {
    "/calls": {
      "get": {
        "summary": "/calls",
        "description": "Search for calls.",
        "operationId": "calls-get",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "Number of results to return. Max 100.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Specifies the number of rows to skip before starting to return results.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "personId",
            "in": "query",
            "description": "Filter calls by a person ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "phone",
            "in": "query",
            "description": "Filter calls based on the phone number of a specific person or lead. This will finds calls regardless of whether they were incoming or outgoing.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "toNumber",
            "in": "query",
            "description": "Filter calls based on the number that the call was to.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromNumber",
            "in": "query",
            "description": "Filter calls based on the number that the call was from.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"_metadata\": {\n    \"collection\": \"calls\",\n    \"offset\": 0,\n    \"limit\": 10,\n    \"total\": 5\n  },\n  \"calls\": [\n    {\n      \"id\": 18,\n      \"created\": \"2014-06-20T23:28:51Z\",\n      \"updated\": \"2014-08-12T17:24:22Z\",\n      \"createdById\": 4,\n      \"updatedById\": 4,\n      \"phone\": \"555-405-0815\",\n      \"personId\": 12254,\n      \"userId\": 4,\n      \"userName\": \"Agent White\",\n      \"note\": \"A note about the call\",\n      \"outcome\": \"Left Message\",\n      \"isIncoming\": false,\n      \"duration\": 63,\n      \"ringDuration\": 5,\n      \"recordingUrl:\": \"Content is hidden for privacy reasons.\"\n    },\n    ...\n  ]\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "58b53c341065f9c438aa1f7e:58406215c050731900063546"
}
```