v1
latestOpenAPI 3.1.02026-08-0420819698.7 KBTasks
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
meta | This property has shortcuts to get other information related to the Task such as the Task's invoices, labor parts usage and instructions. name | The Task's name. userID | The 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. teamID | The 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. locationID | The id of the Location in which this Task belongs to. template | This field indicates if the task is a 'template' that spawns other tasks based on schedules or not. createdDate | The date this Task was created. This is a unix timestamp. startDate | By 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. scheduledStart | The scheduled start date of the Task. This is a unix timestamp. A value of null means no scheduled start date is set. scheduledEnd | The scheduled end date of the Task. This is a unix timestamp. A value of null means no scheduled end date is set. due | The date this Task is due. This is a unix timestamp. dateCompleted | The date this Task was completed. This is a unix timestamp. A value of 0 means this Task is not completed. lastEdited | The date this Task was last edited. This is a unix timestamp. description | The decription of a task. completedByUser | The id of the User that completed this Task. lastEditedByUser | The id of the User that last edited the task. assetID | The id of the Asset that this Task belongs to. completedUserWage | The price per hour of the User's Wage at the point in time when the task was completed. priority | The priority of the Task. downtime | The amount of downtime in seconds caused by this Task. estimatedTime | The estimated time of the task. This is the time it takes to complete the task in minutes. completionNotes | Notes inputted by the user at the time of task completion. requestorName | The name of the person that requested this Task. requestorEmail | The email of the person that requested this Task. requestorPhone | The phone number of the person that requested this Task. requestTile | The title of the work request being submitted. requestField1 | Work request portal custom field 1. requestField2 | Work request portal custom field 2. requestField3 | Work request portal custom field 3. requestDropdown1 | Work request portal custom dropdown box 1. requestDropdown2 | Work request portal custom dropdown box 2. requestDropdown3 | Work request portal custom dropdown box 3. requestorDescription | The description of the request submitted via the Work Request portal. type | 1 = 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; status | 1 - Complete, 0 - Incomplete, Note: this property indicates a task status with respect to task completion. For the custom task status refer to statusID statusID | The 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. poIDs | An 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. meta1 | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. meta2 | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. meta3 | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. geoLocation | The location of a task on a Map. customTags | An array of custom tags associated with the task.
Query parameters
This parameter is used to only get specific Tasks. This parameter accepts a comma delimited list of task IDs.
This parameter is used to only get Tasks that are linked to an asset. This parameter accepts a comma delimited list of asset IDs.
This parameter is used to only get Tasks at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.
This parameter is used to only get Tasks of a specific type. This parameter accepts a comma delimited list of task types.
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 %.
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.
This parameter is used to only get Tasks that were last edited before the unix timestamp passed into the end parameter.
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.
This parameter is a result limiter. The default is set to return no more than 100 results at one time.
This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.
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.
This parameter is used to only get Tasks that were completed before the unix timestamp passed into this parameter.
This parameter is used as the start of a scheduled-date window. Tasks are returned when their scheduled date range overlaps this timestamp.
This parameter is used as the end of a scheduled-date window. Tasks are returned when their scheduled date range overlaps this timestamp.
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.
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.
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.
This parameter is used to only get Tasks assigned to specific teams/profiles. This parameter accepts a comma delimited list of team IDs.
This parameter is used to filter tasks by users who last edited the task.
This parameter is used to filter tasks by completed status. 1 - Complete 0 - Incomplete
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.
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.
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.
This parameter is used to filter tasks by their associated statusID.
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