Configuration & Audit

note

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

Read · 3

search get by id

Write · 2

create update

Read operations

search/note/searchTry it

search note

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

noteIDsinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

customerIDsinteger

No description in the upstream reference.

datestring

No description in the upstream reference.

dateAddedstring

No description in the upstream reference.

typeIDsinteger

No description in the upstream reference.

employeeIDsinteger

No description in the upstream reference.

contentstring

No description in the upstream reference.

Returns

noteIDsarray

No description in the upstream reference.

Request

/note/search

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

get note

Get Bulk data for note. Accepts an array of noteIDs. Returns a max of 1000 records.

Parameters

noteIDsarray

No description in the upstream reference.

Returns

noteIDinteger

Unique Identifier

officeIDsinteger

No description in the upstream reference.

customerIDinteger

Customer ID

customerNamestring

Customer Name

customerSpousestring

Spouse Field

companyNamestring

Company Name

employeeIDinteger

Employee ID that created the note

employeeNamestring

Employee name that created the note

Request

/note/get

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

Response

success:true

]

count:2

}

by id/note/{id}Try it

Fetch by id note

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

Parameters

No parameters beyond authentication.

Returns

noteIDinteger

Unique Identifier

officeIDsinteger

No description in the upstream reference.

customerIDinteger

Customer ID

customerNamestring

Customer Name

customerSpousestring

Spouse Field

companyNamestring

Company Name

employeeIDinteger

Employee ID that created the note

employeeNamestring

Employee name that created the note

Request

/note/{id}

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

noteID:1600

officeIDs:2

customerID:2124

customerName:"Quarterly Perimeter"

customerSpouse:"sample-customerSpouse"

companyName:"Quarterly Perimeter"

employeeID:5916

employeeName:"Quarterly Perimeter"

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

showCustomer:0

showTech:0

cancellationReasonID:3989

cancellationReason:"sample-cancellationReason"

typeID:8552

type:0

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

referenceID:4185

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

dateUpdated:"2026-04-07 00:00:00"

}

Write operations

create/note/createTry it

create note

Parameters

employeeIDinteger

Foreign key to employees table. contactType - integer - required Foreign key to contactTypes table found via Admin > Preference > Note Types notes - string - required Arbitrary comment string

sendTostring

System field? showOnInvoice - boolean - required 1 to display this note on invoices, 0 to hide

cancellationReasoninteger

Foreign key to cancellationReasons table found via Admin > Preference > Cancellation Reasons

showTechboolean

Note will be displayed to Tech can see on TechRoutes

showCustomerboolean

Note will be displayed to the customer in some service notifications

referenceIDinteger

Subscription ID this note relates to.

Returns

Returns a success acknowledgement.

Request

/note/create

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

Response

success:true

noteID:4821

}

update/note/updateTry it

update note

Parameters

employeeIDinteger

Foreign key to employees table. contactType - integer - required Foreign key to contactTypes table found via Admin > Preference > Note Types

notesstring

Arbitrary comment string

sendTostring

System field? showOnInvoice - boolean - required 1 to display this note on invoices, 0 to hide

cancellationReasoninteger

Foreign key to cancellationReasons table found via Admin > Preference > Cancellation Reasons

showTechboolean

Note will be displayed to Tech can see on TechRoutes

showCustomerboolean

Note will be displayed to the customer in some service notifications

referenceIDinteger

Subscription ID this note relates to. contactID - integer - required Primary key to the notes table.

Returns

Returns a success acknowledgement.

Request

/note/update

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

Response

success:true

noteID:4821

}