Routes
Tasks

This request gets top level information about Tasks such as completed date, assignment, assetID, etc.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

Return data description

PropertyDescription
metaThis property has shortcuts to get other information related to the Task such as the Task's invoices, labor parts usage and instructions.
nameThe Task's name.
userIDThe id of the user this Task is assigned to. A Task can not be assigned to both a Team and a User at the same time.
teamIDThe id of the team this Task is assigned to. A Task can not be assigned to both a Team and a User at the same time.
locationIDThe id of the Location in which this Task belongs to.
templateThis field indicates if the task is a 'template' that spawns other tasks based on schedules or not.
createdDateThe date this Task was created. This is a unix timestamp.
startDateBy default this value is 0 as the startDate is usually the same as the createdDate. Sometimes a task is created such that it is scheduled to start in the future (i.e. after the createdDate). In such a case this value will be a unix timestamp indicating the actual start date of the Task.
scheduledStartThe scheduled start date of the Task. This is a unix timestamp. A value of null means no scheduled start date is set.
scheduledEndThe scheduled end date of the Task. This is a unix timestamp. A value of null means no scheduled end date is set.
dueThe date this Task is due. This is a unix timestamp.
dateCompletedThe date this Task was completed. This is a unix timestamp. A value of 0 means this Task is not completed.
lastEditedThe date this Task was last edited. This is a unix timestamp.
descriptionThe description of a task.
completedByUserThe id of the User that completed this Task.
lastEditedByUserThe id of the User that last edited the task.
assetIDThe id of the Asset that this Task belongs to.
completedUserWageThe price per hour of the User's Wage at the point in time when the task was completed.
priorityThe priority of the Task.
downtimeThe amount of downtime in seconds caused by this Task.
estimatedTimeThe estimated time of the task. This is the time it takes to complete the task in minutes.
completionNotesNotes inputted by the user at the time of task completion.
requestorNameThe name of the person that requested this Task.
requestorEmailThe email of the person that requested this Task.
requestorPhoneThe phone number of the person that requested this Task.
requestTitleThe title of the work request being submitted.
requestField1Work request portal custom field 1.
requestField2Work request portal custom field 2.
requestField3Work request portal custom field 3.
requestDropdown1Work request portal custom dropdown box 1.
requestDropdown2Work request portal custom dropdown box 2.
requestDropdown3Work request portal custom dropdown box 3.
requestorDescriptionThe description of the request submitted via the Work Request portal.
type1 = Preventative Maintanance (PM);, 2 = Unplanned Work Order (WO);, 4 = Planned Work Order (WO);, 5 = Cycle Count;, 6 = Work Request (WR);, 7 = Min Part Threshold;, 8 = Materials Request;
status1 - Complete, 0 - Incomplete, Note: this property indicates a task status with respect to task completion. For the custom task status refer to statusID
statusIDThe current custom status assigned to this task., Note: this indicates the current status of a task. Use GET Statuses to find the value of each statusID.
poIDsAn array of Purchase Order IDs linked to this Task. Returns an empty array if no Purchase Orders are linked.
associatedTaskID (deprecated)Please refer to associatedTask meta property on GET Task Instruction for instruction type 14.
meta1Task meta data. This does not show in the web application, but can be used to track items between integrated systems.
meta2Task meta data. This does not show in the web application, but can be used to track items between integrated systems.
meta3Task meta data. This does not show in the web application, but can be used to track items between integrated systems.
geoLocationThe location of a task on a Map.
customTagsAn array of custom tags associated with the task.
get/v2/tasks

Request

Query parameters

tasksinteger

This parameter is used to only get specific Tasks. This parameter accepts a comma delimited list of task IDs.

assetsinteger

This parameter is used to only get Tasks that are linked to an asset. This parameter accepts a comma delimited list of asset IDs.

locationsinteger

This parameter is used to only get Tasks at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.

typeinteger

This parameter is used to only get Tasks of a specific type. This parameter accepts a comma delimited list of task types.

namestring

This is a parameter used to string search for a name or partial name of a task this parameter expects a string with the wildcard %.

startinteger

This parameter is used to only get Tasks that were last edited after the unix timestamp passed into the start parameter. For example, all Tasks that were last edited after April 18th, 2018.

endinteger

This parameter is used to only get Tasks that were last edited before the unix timestamp passed into the end parameter.

cursorinteger

This parameter is a cursor that selects what taskID you want to start receiving results at. e.g. passing 137 here will only get you tasks with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

completedStartinteger

This parameter is used to only get Tasks that were completed after the unix timestamp passed into this parameter. For example, all Assets that were completed after April 18th, 2018.

completedEndinteger

This parameter is used to only get Tasks that were completed before the unix timestamp passed into this parameter.

scheduledStartinteger

This parameter is used as the start of a scheduled-date window. Tasks are returned when their scheduled date range overlaps this timestamp.

scheduledEndinteger

This parameter is used as the end of a scheduled-date window. Tasks are returned when their scheduled date range overlaps this timestamp.

orderBystring

This parameter sorts based on the value you pass. Negative parameters are used to reverse sort order. This supports sorting by due, createdDate, dateCompleted, scheduledStart, scheduledEnd, and lastEdited.

geoLocationboolean

This parameter is used to filter results that contain a geoLocation property. By default it is false and will return all tasks with and without geoLocation property. If true, it will only return tasks with a geoLocation property.

usersinteger

This parameter filters tasks by assignee user IDs. It returns tasks directly assigned to those users and tasks assigned through team/profile membership (including multi-user assignments). This parameter accepts a comma delimited list of user IDs.

teamsinteger

This parameter is used to only get Tasks assigned to specific teams/profiles. This parameter accepts a comma delimited list of team IDs.

lastEditedByUsersstring

This parameter is used to filter tasks by users who last edited the task.

statusinteger

This parameter is used to filter tasks by completed status. 1 - Complete 0 - Incomplete

meta1integer

This parameter is used to filter tasks by task meta data. This does not show in the web application, but can be used to track items between integrated systems.

meta2integer

This parameter is used to filter tasks by task meta data. This does not show in the web application, but can be used to track items between integrated systems.

meta3integer

This parameter is used to filter tasks by task meta data. This does not show in the web application, but can be used to track items between integrated systems.

statusIDsstring

This parameter is used to filter tasks by their associated statusID.

tagstring

This parameter is used to filter results that contain a certain custom tag. The tag must match exactly, i.e. "Tag" would not match "My Custom Tag". Searching for "@My Custom Tag;" is equivalent to searching for "My Custom Tag" but because custom tags are stored with an at sign ("@") at the beginning and a semicolon (";") at the end it is recommended that the param follows the same format.

Response

Pagination using Page & Limit

taskIDinteger
poIDsinteger[]
namestring
userIDinteger
teamIDinteger
locationIDinteger
templateboolean
createdDateinteger
scheduledStartinteger
scheduledEndinteger
dueinteger
descriptionstring
dateCompletedinteger
lastEditedinteger
lastEditedByUserinteger
completedByUserinteger
assetIDinteger
completedUserWageinteger
priorityinteger
priorityIDinteger
downtimeinteger
completionNotesunknown
requestorNameunknown
requestorEmailunknown
requestorPhoneunknown
requestTitleunknown
requestField1unknown
requestField2unknown
requestField3unknown
requestDropdown1unknown
requestDropdown2unknown
requestDropdown3unknown
requestorDescriptionunknown
meta1unknown
meta2unknown
meta3unknown
statusIDinteger
typeinteger
statusinteger

Changes

    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status