Customers & Sales

review

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

Read · 4

search get by id summary

Write · 1

update

Read operations

search/review/searchTry it

search review

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

feedbackIDsinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

customerIDsinteger

No description in the upstream reference.

appointmentIDsinteger

No description in the upstream reference.

datestring

No description in the upstream reference.

starRatinginteger

No description in the upstream reference.

favorableinteger

No description in the upstream reference.

includeDatainteger

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

Returns

reviewIDsarray

No description in the upstream reference.

Request

/review/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/review/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'feedbackIDs=1' \
  --data-urlencode 'officeIDs=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/review/getTry it

get review

Get Bulk data for review. Accepts an array of feedbackIDs. Returns a max of 1000 records. This function has an additional non-standard filter "includeCustomers". If true, the Customer object will be included in the results.

Parameters

feedbackIDsarray

No description in the upstream reference.

includeCustomersinteger

Set true to include the Customer object in review results..

pruneSensitiveInfointeger

Set true to return review text that has been pruned of credit card, phone, and email information.

pruneProfanityinteger

Set true to return review text that has been pruned of common profanity.

Returns

feedbackIDinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

customerIDinteger

No description in the upstream reference.

appointmentIDinteger

No description in the upstream reference.

datestring

No description in the upstream reference.

starRatinginteger

No description in the upstream reference.

feedbackstring

No description in the upstream reference.

favorableinteger

No description in the upstream reference.

Request

/review/get

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

Response

success:true

]

count:2

}

by id/review/{id}Try it

Fetch by id review

Get review data for single ID -- please provide a specific record ID in the URL structure. This function has an additional non-standard filter "includeCustomers". If true, the Customer object will be included in the results.

Parameters

includeCustomersinteger

Set true to include the Customer object in review results..

pruneSensitiveInfointeger

Set true to return review text that has been pruned of credit card, phone, and email information.

pruneProfanityinteger

Set true to return review text that has been pruned of common profanity.

Returns

feedbackIDinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

customerIDinteger

No description in the upstream reference.

appointmentIDinteger

No description in the upstream reference.

datestring

No description in the upstream reference.

starRatinginteger

No description in the upstream reference.

feedbackstring

No description in the upstream reference.

favorableinteger

No description in the upstream reference.

Request

/review/{id}

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

Response

success:true

feedbackID:1107

officeIDs:2

customerID:2124

appointmentID:7501

date:"2026-05-06 00:00:00"

starRating:2

feedback:"sample-feedback"

favorable:2

}

summary/review/summaryTry it

summary review

Parameters

zipCodesarray

Zip codes to summarize

citiesarray

Cities to summarize

officeIDsarray

Foreign key to offices table. Default: officeID associated with the API key sent.

customerIDsarray

Foreign key to customers table

startTimestring

Left bound for feedback time

endTimestring

Right bound for feedback time

Returns

starsobject

Object filled with stars E.G. {1:100, 2:101, 3:200, 4:300, 5:400}

zipsobject

Object filled with zip information E.G. {75252: {num:700, average: 2.5, zip: 75252} }

citiesobject

Object filled with city information E.G. {Dallas: {num:700, average: 2.5, city: "Dallas"} }

averagedouble

Average star rating for the given parameters

Request

/review/summary

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

Response

success:true

key:"value"

}

key:"value"

}

key:"value"

}

average:196.5

}

Write operations

update/review/updateTry it

update review

Parameters

appointmentIDinteger

Foreign key to appointments table

customerIDinteger

Foreign key to customers table

starRatinginteger

Integer 1-5 as star rating.

feedbackstring

Customer Feedback String

timestring

Time the feedback was given feedbackID - integer - required Primary key to the customerFeedback table.

Returns

Returns a success acknowledgement.

Request

/review/update

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

Response

success:true

reviewID:4821

}