Search leads within a territory

Authorization

X-Api-Key<token>

Company API key (format: dkp_...). Required on every request.

In: header

AuthorizationRequiredBearer <token>

In: header

Path Parameters

idRequiredinteger

Query Parameters

per_pageinteger

Default: 50Minimum: 1Maximum: 200

fromstring

Filter leads created on or after this date

Format: "date"

tostring

Filter leads created on or before this date

Format: "date"

user_idinteger

Filter by created_by user ID

team_idinteger

Filter by team ID

status_idinteger

Filter by lead status ID

curl -X GET "https://app.doorknockpro.com/api/v1/territories/0/leads?per_page=50&from=2019-08-24&to=2019-08-24&user_id=0&team_id=0&status_id=0" \
  -H "X-Api-Key: <token>" \
  -H "Authorization: Bearer <token>"

Paginated leads within the territory

{
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 0,
    "from": 0,
    "last_page": 0,
    "per_page": 0,
    "to": 0,
    "total": 0
  },
  "data": [
    {
      "id": 0,
      "name": "string",
      "email": "string",
      "phone": "string",
      "alter_email": "string",
      "alter_phone": "string",
      "notes": "string",
      "property_type_id": 0,
      "team_id": 0,
      "created_by": 0,
      "lead_status_id": 0,
      "appointment": "2019-08-24T14:15:22Z",
      "related_assets": [
        "string"
      ],
      "address": {
        "house": "string",
        "street": "string",
        "city": "string",
        "state_province": "string",
        "country": "string",
        "zip_code": "string"
      },
      "location": {
        "lat": 0,
        "lng": 0
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Search leads within a territory

Authorization

Path Parameters

Query Parameters

Response

TypeScript