Customers & Sales

knock

3 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 3

Read operations

search/knock/searchTry it

search knock

Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.

Example

dateAdded={"operator":">","value":"2016-01-01"}

Example

dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}

Available operators

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.

Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.

Parameters

knockIDinteger

Primary Key

doorIDinteger

Door the knock is associated with

includeDatainteger

{0,1} Sends the resolved objects for the first 1000 IDs. If there are more than 1000 items an additional property knockIDsNoDataExported will specify the items that are not included in the resolved knock array.

Returns

knockIDsarray

No description in the upstream reference.

Request

/knock/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/knock/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'knockID=1' \
  --data-urlencode 'doorID=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/knock/getTry it

get knock

Get Bulk data for knock. Accepts an array of knockIDs. Returns a max of 1000 records.

Parameters

knockIDsarray

No description in the upstream reference.

Returns

knockIDinteger

Primary Key

typeinteger

0 - competitor, 1 - objection

doorIDinteger

No description in the upstream reference.

serviceIDinteger

No description in the upstream reference.

employeeIDinteger

No description in the upstream reference.

dateAddedstring

No description in the upstream reference.

Request

/knock/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/knock/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'knockIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/knock/{id}Try it

Fetch by id knock

Get knock data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

knockIDinteger

Primary Key

typeinteger

0 - competitor, 1 - objection

doorIDinteger

No description in the upstream reference.

serviceIDinteger

No description in the upstream reference.

employeeIDinteger

No description in the upstream reference.

dateAddedstring

No description in the upstream reference.

Request

/knock/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/knock/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

knockID:2786

type:0

doorID:5628

serviceID:1795

employeeID:5916

dateAdded:"2026-08-10 00:00:00"

}