Scheduling

task

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/task/searchTry it

search task

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

taskIDsinteger

Primary key.

officeIDinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

customerIDinteger

CustomerID the task relates to.

assignedTointeger

EmployeeID the task is assigned to

completedByinteger

EmployeeID who completed the task

typeinteger

Type of task: 0 - Task, 1 - Alert

dueDatestring

Time the task or alert is due.

Returns

taskIDsarray

No description in the upstream reference.

Request

/task/search

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

get task

Get Bulk data for task. Accepts an array of taskIDs. Returns a max of 1000 records.

Parameters

taskIDsarray

No description in the upstream reference.

Returns

taskIDsinteger

Primary key.

officeIDinteger

officeID of the task

customerIDinteger

customerID the task is related to

assignedTointeger

EmployeeID the task is assigned to

completedByinteger

EmployeeID who completed the task

typeinteger

Type of task: 0 - Alert, 1 - Task

dueDatestring

Time the task or alert is due.

dateAddedstring

Time the task or alert was added.

Request

/task/get

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

Response

success:true

]

count:2

}

by id/task/{id}Try it

Fetch by id task

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

Parameters

No parameters beyond authentication.

Returns

taskIDsinteger

Primary key.

officeIDinteger

officeID of the task

customerIDinteger

customerID the task is related to

assignedTointeger

EmployeeID the task is assigned to

completedByinteger

EmployeeID who completed the task

typeinteger

Type of task: 0 - Alert, 1 - Task

dueDatestring

Time the task or alert is due.

dateAddedstring

Time the task or alert was added.

Request

/task/{id}

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

taskIDs:1

officeID:2602

customerID:2124

assignedTo:2

completedBy:1

type:0

dueDate:"2026-01-02 00:00:00"

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

category:2

categoryDescription:1

task:"sample-task"

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

referenceID:4185

phone:"5558675309"

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

status:"Active"

}

Write operations

create/task/createTry it

create task

Create a new task or alert.

Parameters

referenceIDinteger

SubscriptionID the task pertains to

phonestring

Phone number for the task

categoryinteger

categoryID of the task values: Appt Status (15), Billing (1), Customer Care (10), Customer Status (13), Feedback (7), Follow Up (5), Office (6), Reminder Reply (9), Sales (11), Scheduling (2), Service (4), SMS Reply (12), Subscription Status (14), Tech Flag (8), Voice Mail (3)

addedByinteger

EmployeeID who added the task or alert

assignedTointeger

EmployeeID the task is assigned to

dueDatestring

Date the task is due

taskstring

Text description of the task

statusinteger

0: Pending, 1: Completed, 2: In Use, 3: Urgent, -1: Deleted

Returns

Returns a success acknowledgement.

Request

/task/create

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

Response

success:true

taskID:4821

}

update/task/updateTry it

update task

Update a task.

Parameters

typeinteger

0: task, 1: alert

customerIDinteger

CustomerID the task pertains to

referenceIDinteger

SubscriptionID the task pertains to

phonestring

Phone number for the task

categoryinteger

addedByinteger

EmployeeID who added the task or alert

assignedTointeger

EmployeeID the task is assigned to

dueDatestring

Date the task is due

Returns

Returns a success acknowledgement.

Request

/task/update

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

Response

success:true

taskID:4821

}