Configuration & Audit

document

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

Read · 3

search get by id

Write · 3

create update createEncoded

Read operations

search/document/searchTry it

search document

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

uploadIDsinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

officeIDinteger

No description in the upstream reference.

customerIDsinteger

customerID associated with the document

customerIDinteger

customerID associated with the document

appointmentIDsinteger

appointmentID associated with the document

appointmentIDinteger

appointmentID associated with the document

formTemplateIDinteger

formTemplateID for pulling specific form types

Returns

documentIDsarray

No description in the upstream reference.

Request

/document/search

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

get document

Get Bulk data for document. Accepts an array of uploadIDs. Returns a max of 1000 records.

Parameters

uploadIDsarray

No description in the upstream reference.

includeDocumentLinkinteger

Send as 1 to retrieve a link to the document on AWS with a 15 day TTL.

Returns

uploadIDinteger

Unique Identifier

officeIDinteger

No description in the upstream reference.

customerIDinteger

Customer ID

dateAddedstring

date this upload was added

addedByinteger

Employee ID that added this

descriptionstring

Description for this upload

showCustomerinteger

Set to 1 if this upload is visible to the customer

showTechinteger

Set to 1 if this upload is visible to the technician through TechRoutes.

Request

/document/get

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

Response

success:true

]

count:2

}

by id/document/{id}Try it

Fetch by id document

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

Parameters

includeDocumentLinkinteger

Send as 1 to retrieve a link to the document on AWS with a 15 day TTL.

Returns

uploadIDinteger

Unique Identifier

officeIDinteger

No description in the upstream reference.

customerIDinteger

Customer ID

dateAddedstring

date this upload was added

addedByinteger

Employee ID that added this

descriptionstring

Description for this upload

showCustomerinteger

Set to 1 if this upload is visible to the customer

showTechinteger

Set to 1 if this upload is visible to the technician through TechRoutes.

Request

/document/{id}

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

Response

success:true

uploadID:3567

officeID:2602

customerID:2124

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

addedBy:1

description:"Sample value returned by the mock engine."

showCustomer:0

showTech:0

appointmentID:7501

prefix:1

}

Write operations

create/document/createTry it

create document

Upload file as multipart/form-data with parameter name uploadFile

Parameters

appointmentIDinteger

Appointment ID this document relates to

showCustomerboolean

If set true this document will be accessable to the customer it is attached to.

showTechboolean

If set true this document will be accessable to technicians servicing this customer.

Returns

Returns a success acknowledgement.

Request

/document/create

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

Response

success:true

documentID:4821

}

update/document/updateTry it

update document

Update the attributes of a customer upload.

Parameters

appointmentIDinteger

Appointment ID this document relates to

showCustomerboolean

If set true this document will be accessable to the customer it is attached to.

showTechboolean

If set true this document will be accessable to technicians servicing this customer. uploadID - integer - required ID of upload to update

Returns

Returns a success acknowledgement.

Request

/document/update

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

Response

success:true

documentID:4821

}

createEncoded/document/createEncodedTry it

createEncoded document

Allows file upload using a Base64 representation submitted through POST, GET or query string parameters

Parameters

appointmentIDinteger

Appointment ID this document relates to

showCustomerboolean

If set true this document will be accessable to the customer it is attached to.

showTechboolean

If set true this document will be accessable to technicians servicing this customer. encodedFile - string - required Base64 representation of a file. filename - string - required Name of encoded file

Returns

Returns a success acknowledgement.

Request

/document/createEncoded

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

Response

success:true

documentID:4821

}