Customers & Sales

contract

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

Read · 3

search get by id

Write · 1

create

Destructive · 1

delete

Read operations

search/contract/searchTry it

search contract

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

officeIDsinteger

No description in the upstream reference.

contractIDsinteger

No description in the upstream reference.

customerIDsinteger

No description in the upstream reference.

subscriptionIDsinteger

No description in the upstream reference.

dateSignedstring

The date the contract was signed.

dateAddedstring

The date the contract was added.

includeDatainteger

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

Returns

contractIDsarray

No description in the upstream reference.

Request

/contract/search

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

get contract

Get Bulk data for contract. Accepts an array of contractIDs. Returns a max of 1000 records.

Parameters

contractIDsarray

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

contractIDsinteger

No description in the upstream reference.

contractIDinteger

No description in the upstream reference.

customerIDsinteger

No description in the upstream reference.

subscriptionIDsinteger

No description in the upstream reference.

dateSignedstring

The date the contract was signed.

dateAddedstring

The date the contract was added.

documentStateinteger

State of the document e.g. WIP, COMPLETED

Request

/contract/get

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

Response

success:true

]

count:2

}

by id/contract/{id}Try it

Fetch by id contract

Get contract 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

contractIDsinteger

No description in the upstream reference.

contractIDinteger

No description in the upstream reference.

customerIDsinteger

No description in the upstream reference.

subscriptionIDsinteger

No description in the upstream reference.

dateSignedstring

The date the contract was signed.

dateAddedstring

The date the contract was added.

documentStateinteger

State of the document e.g. WIP, COMPLETED

Request

/contract/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/contract/{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

contractIDs:1

contractID:2464

customerIDs:0

subscriptionIDs:1

dateSigned:"2026-04-08 00:00:00"

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

documentState:1

}

Write operations

create/contract/createTry it

create contract

Create the default contract for the subscriptionID or subscriptionLink sent. If sending a signedFile, upload the file as multipart/form-data with parameter name uploadFile

Parameters

subscriptionIDinteger

Foreign key to subscriptions table.

subscriptionLinkinteger

Alternative to subscriptionID. This is the "SubscriptionID" sent during an API insert through import/main.

emailCustomerinteger

Set as 1 to also send a link to the customer via email.

dateSignedstring

The date the contract was signed. Required if uploading a signed document.

base64EncodedFilestring

The Base64 encoded signed contract. Pass this if not sending the file.

Returns

Returns a success acknowledgement.

Request

/contract/create

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

Response

success:true

contractID:4821

}

Destructive operations

delete/contract/deleteTry it

delete contract

Delete an uploaded contract

Parameters

contractIDinteger

Id of the contract to be deleted.

Returns

Returns a success acknowledgement.

Request

/contract/delete

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

Response

success:true

contractID:4821

}