The flow name used in making a task, refers to the existing flow in the organization. When creating a task, you cannot use the flow with the name Handover because it has been used as a reserved key.
Organization Entity Information: Encompasses the organization's name, email, and ID. This information is present in the task data upon task creation and processing.
Status that describes the process of a task:
Unassigned : Tasks that have been created but have not been assigned to the user field
Ongoing : Tasks that have been assigned to the user field and are in progress
Done : Tasks that have been completed by the user field.
information about the user who last modified a task. It provides details about the user who made the most recent update to the task, typically including their email address.
Identifies where the task was completed from: WEB, MOBILE, System (for sample data). When set to MOBILE, only a user assigned to the task can mark its status as Done.
The travelDuration is calculated as the time taken to travel between two consecutive visits and is measured in minutes. It is obtained by subtracting the doneTime of the current visit from the doneTime of the previous visit in the optimized route.
The duration in this context is also measured in minutes and represents the time taken to complete a particular visit or task. It is calculated by subtracting the doneTime of the current visit from th page1DoneTime of the same visit. This calculation allows us to determine the time it took to complete the specific task or visit, starting from when it was initiated (page1DoneTime) until it was marked as completed (doneTime).
The Unique ID is used to mark a vehicle during route optimization to ensure that the visit associated with this vehicle ID remains assigned to the same vehicle in the subsequent optimization route and does not get randomly assigned to another vehicle.
The purpose of marking a vehicle on a successfully optimized visit is to ensure that the visit can be assigned to the same vehicle in the next optimizer route.
The routePlannedOrder serves as the key to identify that a visit has been successfully optimized within a specific route. It also helps to determine the order of that visit within the optimized route.
A flag used to indicate whether a task employs geolock or not. Geolock is a feature that restricts task access based on predefined geographic locations and radius. When useGeoLock is set to true, it means that the task uses geolock to limit access based on the task's specified geographic parameters.
Define geolocation-based access restrictions for tasks. It is an array of objects that contain information about allowed locations and their corresponding radius. Tasks are accessible only when accessed from within the specified locations and within the defined radius. If an attempt is made to access the task from outside the allowed area, access will be denied.
By default this number is generated based on the task created time in epoch format, orderIndex is used to define the order of this Task in the Task list. User can define it by number value.
This key is related to the Cross Docking configuration. When a user dispatches the result, a handover task is generated for the Sub Hub. This key serves to distinguish the Handover task from other tasks within the platform.
This key is associated with the Auto Split configuration. If the routing result suggests a visit that needs to be split into two or more visits, upon dispatch, we generate the split tasks. The parentTaskId signifies the main task that has been split.
This key identifies the segment of the split task, corresponding to the Auto Split configuration. It helps in tracking the divided tasks effectively.
Example: 1/2, 2/2
A flag indicating whether the routing optimization considers visits within the same group. This ensures that visits within the same group are assigned to the same vehicle and prioritized sequentially.
This key indicates that visits belong to the same group if they are set to the same name. The routing solution will suggest assigning visits with the same group to the same vehicle.
Priority ranges from 0 to 100, with the default value set to 0. A lower number indicates a higher priority compared to other visits within the same group.
This key depends on doneOrder key, generated when task done by calculating distance between done tasks and distance between Hub to task if done order is 1
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Docs","colors":{"primary":"#02A8F3","light":"#02A8F3","dark":"#028FCF"},"favicon":"https://mintcdn.com/mile-app/JbFasViqaZTzE9Zc/favicon.ico?fit=max\u0026auto=format\u0026n=JbFasViqaZTzE9Zc\u0026q=85\u0026s=4e7ddbcee052a480a983e57b5e25103b","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"}}},"search":{},"seo":{"metatags":{"robots":"noindex, nofollow"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mile-app","hasAudioNarration":false,"actualSubdomain":"mile-app","customDomains":["docsy3.mile.app"],"gitSource":{"type":"gitlab","owner":"paketid","repo":"mileapp-docs","deployBranch":"whitelabel","contentDirectory":"","isPrivate":true,"projectId":76553900,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6abdd0a3503afc6fc766f9c9","collectionId":"7da1e5b0-9dcc-4967-b311-365ce82d22c4","liveDeploymentHistoryId":"6abdd0a3503afc6fc766f9c9","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6abdd0a3503afc6fc766f9c9","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guides","count":209},{"language":"default","tag":"API Reference","count":199},{"language":"default","tag":"Task","count":99},{"language":"default","tag":"Flow","count":76},{"language":"default","tag":"Setting","count":60},{"language":"default","tag":"Automation","count":39},{"language":"default","tag":"Flow Builder","count":33},{"language":"default","tag":"Route Optimization","count":32},{"language":"default","tag":"Routing","count":28},{"language":"default","tag":"Overview","count":25}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"a[href=\"/\"]>img,header>a:first-child img,img[src*=\"/logo/\"],nav>a:first-child img{width:150px!important;height:auto!important;max-width:150px!important}"}],"page":{"pagePath":"api-reference/objects/task-object","slug":"/api-reference/objects/task-object","pageMetadata":{"title":"Task object","openapi-schema":"openapi/public/openapi-full.json Task","description":null,"href":"/api-reference/objects/task-object"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Task object","openapi-schema":"openapi/public/openapi-full.json Task","description":null,"href":"/api-reference/objects/task-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mile-app/1d49f46686dcd76c/scripts/build-openapi.js","/_mintlify/custom/mile-app/bbd4ec23fcfb0c2b/scripts/check-schema.js","/_mintlify/custom/mile-app/620df530e90e7f77/scripts/generate-tag-overviews.js"],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"_id":{"type":"string","description":"An identity that is automatically generated as a technical identification of a task.","uniqueKey":"_id","typeLabel":"string"},"organizationId":{"type":"string","description":"The identity of the organizational account where the task was created and processed.","uniqueKey":"organizationId","typeLabel":"string"},"flowId":{"type":"string","description":"Identity of a flow that is used in the task creation process, (supporting data in identifying flows).","uniqueKey":"flowId","typeLabel":"string"},"hubId":{"type":"string","description":"Unique ID to identify a hub.","uniqueKey":"hubId","typeLabel":"string"},"flow":{"type":"string","description":"The flow name used in making a task, refers to the existing flow in the organization. When creating a task, you cannot use the flow with the name `Handover` because it has been used as a reserved key.","uniqueKey":"flow","typeLabel":"string"},"organization":{"type":"object","description":"Organization Entity Information: Encompasses the organization's name, email, and ID. This information is present in the task data upon task creation and processing.","properties":{"id":{"type":"string","description":"An unique identifier for the organization.This data will be displayed based on `organizationId`.","uniqueKey":"organization.id","typeLabel":"string"},"name":{"type":"string","description":"Name of organization.This data will be displayed based on `organizationId`.","uniqueKey":"organization.name","typeLabel":"string"},"email":{"type":"string","description":"Email of organization.This data will be displayed based on `organizationId`.","uniqueKey":"organization.email","typeLabel":"string"}},"uniqueKey":"organization","typeLabel":"object"},"hub":{"type":"object","description":"Information of hub entity : contains hub name, hub id, coordinates.","properties":{"id":{"type":"string","description":"An unique identifier for the hub. This data will be displayed based on `hubId`.","uniqueKey":"hub.id","typeLabel":"string"},"name":{"type":"string","description":"The name of hub. This data will be displayed based on `hubId`.","uniqueKey":"hub.name","typeLabel":"string"},"lat":{"type":"number","description":"Coordinate latitude of hub. This data will be displayed based on `hubId`.","uniqueKey":"hub.lat","typeLabel":"number"},"lng":{"type":"number","description":"Coordinate longitude of hub. This data will be displayed based on `hubId`.","uniqueKey":"hub.lng","typeLabel":"number"}},"uniqueKey":"hub","typeLabel":"object"},"title":{"type":"string","description":"The value of a task is used as the Title of the task, which will appear on task pages on the web and apps.","uniqueKey":"title","typeLabel":"string"},"content":{"type":"string","description":"The value of a task is used as a Content, which will appear on task pages on the web and in apps.","uniqueKey":"content","typeLabel":"string"},"label":{"type":"string","description":"The value of a task is used as a Label, which will appear on task pages on the web and in apps.","uniqueKey":"label","typeLabel":"string"},"status":{"type":"string","description":"Status that describes the process of a task: \n `Unassigned` : Tasks that have been created but have not been assigned to the user field \n `Ongoing` : Tasks that have been assigned to the user field and are in progress \n `Done` : Tasks that have been completed by the user field.","uniqueKey":"status","typeLabel":"string"},"assignee":{"type":"array","description":"List of email that has been assigned the task.","items":{"type":"string","uniqueKey":"assignee.items.[INDEX]","typeLabel":"string"},"uniqueKey":"assignee","typeLabel":"string[]"},"assignedTo":{"type":"object","description":"Detail information of assignee : contains field user name, email, hub, organization and user role.","properties":{"id":{"type":"string","description":"An unique identifier for the user.This data will be displayed based on `assignee`.","uniqueKey":"assignedTo.id","typeLabel":"string"},"name":{"type":"string","description":"Name of user assignee.This data will be displayed based on `assignee`.","uniqueKey":"assignedTo.name","typeLabel":"string"},"email":{"type":"string","description":"Email of user assignee.This data will be displayed based on `assignee`.","uniqueKey":"assignedTo.email","typeLabel":"string"},"hubId":{"type":"array","description":"Hub Id of user assignee.This data will be displayed based on `assignee`.","items":{"type":"string","uniqueKey":"assignedTo.hubId.items.[INDEX]","typeLabel":"string"},"uniqueKey":"assignedTo.hubId","typeLabel":"string[]"},"roleId":{"type":"string","description":"ID role of user assignee.This data will be displayed based on `assignee`.","uniqueKey":"assignedTo.roleId","typeLabel":"string"}},"uniqueKey":"assignedTo","typeLabel":"object"},"assignedBy":{"type":"string","description":"Email that assigned the task.","uniqueKey":"assignedBy","typeLabel":"string"},"assignedTime":{"type":"string","format":"date-time","description":"Date and time when the task is assigned.","uniqueKey":"assignedTime","typeLabel":"string\u003cdate-time>"},"startTime":{"type":"string","format":"date-time","description":"The initial time for working on a task that can be set by the admin user when the task is created.","uniqueKey":"startTime","typeLabel":"string\u003cdate-time>"},"endTime":{"type":"string","format":"date-time","description":"The deadline for completing tasks that can be set by the admin user when the task is created.","uniqueKey":"endTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"Information of time when the task was last updated.","uniqueKey":"updatedTime","typeLabel":"string\u003cdate-time>"},"updatedBy":{"type":"string","description":"information about the user who last modified a task. It provides details about the user who made the most recent update to the task, typically including their email address.","uniqueKey":"updatedBy","typeLabel":"string"},"createdBy":{"type":"string","description":"Email that created the task.","uniqueKey":"createdBy","typeLabel":"string"},"createdFrom":{"type":"string","description":"Identify where the task was created from: `WEB`, `API`, `Automation`, `Mobile`.","uniqueKey":"createdFrom","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date and time when the task is created.","uniqueKey":"createdTime","typeLabel":"string\u003cdate-time>"},"doneBy":{"type":"string","description":"Email that processed the task until it is done.","uniqueKey":"doneBy","typeLabel":"string"},"doneCoordinate":{"type":"number","description":"Coordinate where the task is done.","uniqueKey":"doneCoordinate","typeLabel":"number"},"doneTime":{"type":"string","format":"date-time","description":"Date and time when the task is finished.","uniqueKey":"doneTime","typeLabel":"string\u003cdate-time>"},"doneFrom":{"type":"string","description":"Identifies where the task was completed from: WEB, MOBILE, System (for sample data). When set to MOBILE, only a user assigned to the task can mark its status as Done.","uniqueKey":"doneFrom","typeLabel":"string"},"openTaskTime":{"type":"string","format":"date-time","description":"openTaskTime is data when the task was last opened when it was still ongoing.","uniqueKey":"openTaskTime","typeLabel":"string\u003cdate-time>"},"waitingTime":{"type":"integer","description":"Time provided (in minute) for a vehicle to wait before start travelling to the next visit.","uniqueKey":"waitingTime","typeLabel":"integer"},"travelDuration":{"type":"number","description":"The `travelDuration` is calculated as the time taken to travel between two consecutive visits and is measured in minutes. It is obtained by subtracting the `doneTime` of the current visit from the `doneTime` of the previous visit in the optimized route.","uniqueKey":"travelDuration","typeLabel":"number"},"duration":{"type":"integer","description":"The `duration` in this context is also measured in minutes and represents the time taken to complete a particular visit or task. It is calculated by subtracting the `doneTime` of the current visit from th `page1DoneTime` of the same visit. This calculation allows us to determine the time it took to complete the specific task or visit, starting from when it was initiated (`page1DoneTime`) until it was marked as completed (`doneTime`).","uniqueKey":"duration","typeLabel":"integer"},"distance":{"type":"integer","description":"Estimated vehicle mileage (in meter).","uniqueKey":"distance","typeLabel":"integer"},"eta":{"type":"string","description":"Estimated Time Of Arrival at the destination.","uniqueKey":"eta","typeLabel":"string"},"etd":{"type":"string","description":"Estimated Time of Departure before start travelling to the next visit.","uniqueKey":"etd","typeLabel":"string"},"assignedVehicleId":{"type":"string","description":"The Unique ID is used to mark a vehicle during route optimization to ensure that the visit associated with this vehicle ID remains assigned to the same vehicle in the subsequent optimization route and does not get randomly assigned to another vehicle.","uniqueKey":"assignedVehicleId","typeLabel":"string"},"assignedVehicle":{"type":"object","description":"The purpose of marking a vehicle on a successfully optimized visit is to ensure that the visit can be assigned to the same vehicle in the next optimizer route.","properties":{"id":{"type":"string","description":"An unique identifier for the vehicle.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.id","typeLabel":"string"},"assignee":{"type":"string","description":"Users's email that assigned to the vehicle.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.assignee","typeLabel":"string"},"name":{"type":"string","description":"Name of vehicle.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.name","typeLabel":"string"},"speed":{"type":"string","description":"Assume the average speed (in km/h) of the vehicle.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.speed","typeLabel":"string"},"workingTime":{"type":"object","description":"Working hours on vehicles containing: startTime, endTime, and multiday.This data will be displayed based on `assignedVehicleId`.","properties":{"startTime":{"type":"string","description":"Time of departure of the vehicle from the hub.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.workingTime.startTime","typeLabel":"string"},"endTime":{"type":"string","description":"Maximum working time of vehicle to operate. This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.workingTime.endTime","typeLabel":"string"},"multiday":{"type":"integer","description":"Additional working days accumulatedbased on the number of days.This data will be displayed based on `assignedVehicleId`.","uniqueKey":"assignedVehicle.workingTime.multiday","typeLabel":"integer"}},"uniqueKey":"assignedVehicle.workingTime","typeLabel":"object"}},"uniqueKey":"assignedVehicle","typeLabel":"object"},"routePlannedOrder":{"type":"integer","description":"The `routePlannedOrder` serves as the key to identify that a visit has been successfully optimized within a specific route. It also helps to determine the order of that visit within the optimized route.","uniqueKey":"routePlannedOrder","typeLabel":"integer"},"idleDuration":{"type":"integer","description":"idleDuration is the total duration of the idle user while working on a task, the user is considered idle when the speed is less than 3 km/h","uniqueKey":"idleDuration","typeLabel":"integer"},"expectedCoordinate":{"type":"string","description":"Coordinates used in MileField to display routes on google maps.","uniqueKey":"expectedCoordinate","typeLabel":"string"},"expectedDoneTime":{"type":"string","description":"Timestamp for expectation done time for the task.","uniqueKey":"expectedDoneTime","typeLabel":"string"},"createdCoordinate":{"type":"string","description":"Coordinate where the task is created.","uniqueKey":"createdCoordinate","typeLabel":"string"},"useGeoLock":{"type":"boolean","description":"A flag used to indicate whether a task employs geolock or not. Geolock is a feature that restricts task access based on predefined geographic locations and radius. When useGeoLock is set to true, it means that the task uses geolock to limit access based on the task's specified geographic parameters.","uniqueKey":"useGeoLock","typeLabel":"boolean"},"geoLock":{"type":"object","description":"Define geolocation-based access restrictions for tasks. It is an array of objects that contain information about allowed locations and their corresponding radius. Tasks are accessible only when accessed from within the specified locations and within the defined radius. If an attempt is made to access the task from outside the allowed area, access will be denied.","properties":{"geoLocation":{"type":"string","description":"Detailed location of lattidude and longitude.","uniqueKey":"geoLock.geoLocation","typeLabel":"string"},"radius":{"type":"integer","description":"Radius of the geolock feature.","uniqueKey":"geoLock.radius","typeLabel":"integer"}},"uniqueKey":"geoLock","typeLabel":"object"},"geoLockTrigger":{"type":"string","description":"The identifier for geolock usage is triggered when a task begins or when a task is completed.","uniqueKey":"geoLockTrigger","typeLabel":"string"},"refId":{"type":"string","description":"Task reference identity that involves multiple flows.","uniqueKey":"refId","typeLabel":"string"},"idLocal":{"type":"string","description":"Id / Identity of a task created by mobile.","uniqueKey":"idLocal","typeLabel":"string"},"orderIndex":{"type":"number","description":"By default this number is generated based on the task created time in epoch format, orderIndex is used to define the order of this Task in the Task list. User can define it by number value.","uniqueKey":"orderIndex","typeLabel":"number"},"isSample":{"type":"boolean","description":"An identifier is used to distinguish whether this task is sample data or user-generated real data.","uniqueKey":"isSample","typeLabel":"boolean"},"histories":{"type":"array","description":"History identity when a task was created, modified, or deleted.","items":{"type":"object","properties":{"_id":{"type":"string","description":"An unique identifier for the task history.","uniqueKey":"histories.items.[INDEX]._id","typeLabel":"string"},"action":{"type":"string","description":"Actions taken on tasks. There are 7 types of *action*:`create`,`put`,`patch`, `delete`, `assign`, `unassign`, `move`.","uniqueKey":"histories.items.[INDEX].action","typeLabel":"string"},"notes":{"type":"string","description":"Detailed explanation of history. Usually use a combination of **action** and **changeBy**.","uniqueKey":"histories.items.[INDEX].notes","typeLabel":"string"},"changeData":{"type":"object","description":"An object that contains task data before the action is performed.","additionalProperties":true,"uniqueKey":"histories.items.[INDEX].changeData","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"The date the history was created.","uniqueKey":"histories.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"histories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"histories","typeLabel":"object[]"},"deviceInformation":{"type":"array","description":"An information about device that used by user for complete the task.","items":{"type":"object","additionalProperties":true,"uniqueKey":"deviceInformation.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deviceInformation","typeLabel":"object[]"},"routingResultId":{"type":"string","description":"This key is related to the Cross Docking configuration. When a user dispatches the result, a handover task is generated for the Sub Hub. This key serves to distinguish the Handover task from other tasks within the platform.","uniqueKey":"routingResultId","typeLabel":"string"},"parentTaskId":{"type":"string","description":"This key is associated with the Auto Split configuration. If the routing result suggests a visit that needs to be split into two or more visits, upon dispatch, we generate the split tasks. The parentTaskId signifies the main task that has been split.","uniqueKey":"parentTaskId","typeLabel":"string"},"autoSplit":{"type":"string","description":"This key indicates the type of Auto Split used, which can be either `Equal` or `Maximize`. It indicates the method employed for splitting tasks.","uniqueKey":"autoSplit","typeLabel":"string"},"splitNumber":{"type":"string","description":"This key identifies the segment of the split task, corresponding to the Auto Split configuration. It helps in tracking the divided tasks effectively. \n**Example**: `1/2, 2/2`","uniqueKey":"splitNumber","typeLabel":"string"},"useVisitGroup":{"type":"string","description":"A flag indicating whether the routing optimization considers visits within the same group. This ensures that visits within the same group are assigned to the same vehicle and prioritized sequentially.","uniqueKey":"useVisitGroup","typeLabel":"string"},"visitGroup":{"type":"string","description":"This key indicates that visits belong to the same group if they are set to the same name. The routing solution will suggest assigning visits with the same group to the same vehicle.","uniqueKey":"visitGroup","typeLabel":"string"},"visitGroupPriority":{"type":"string","description":"Priority ranges from 0 to 100, with the default value set to 0. A lower number indicates a higher priority compared to other visits within the same group.","uniqueKey":"visitGroupPriority","typeLabel":"string"},"vehicleSubHubDistanceLimit":{"type":"string","description":"This key stores the value of the maximum distance a vehicle sub hub can travel. It is related to cross docking.","uniqueKey":"vehicleSubHubDistanceLimit","typeLabel":"string"},"doneOrder":{"type":"integer","description":"Generated when the task done for flagging the sequence of completed tasks.","uniqueKey":"doneOrder","typeLabel":"integer"},"isLastDoneOrder":{"type":"boolean","description":"Generated when the task done for flagging the latest completed task.","uniqueKey":"isLastDoneOrder","typeLabel":"boolean"},"inLocation":{"type":"string","description":"Generated when user enter the range (50m) of task coordinates. This feature activated when task has geoloc feature.","uniqueKey":"inLocation","typeLabel":"string"},"outLocation":{"type":"string","description":"Generated when user out the range (50m) of task coordinates after inLocation recorded.","uniqueKey":"outLocation","typeLabel":"string"},"travelDistance":{"type":"string","description":"This key depends on doneOrder key, generated when task done by calculating distance between done tasks and distance between Hub to task if done order is 1","uniqueKey":"travelDistance","typeLabel":"string"}},"example":{"title":"Example","value":{"_id":"6352736c628401059b37a2e2","organizationId":"6153defcbd80d354e0708a74","flowId":"632ac456c400337f183d14ff","hubId":"615bb662bd32b7726709acd2","flow":"Delivery","organization":{"_id":"63e083f9b934ff3dc2180132","name":"mileapp","email":"[email protected]"},"hub":{"id":"64006d2da2b2125d925642d2","name":"bandung","lat":-6.91266,"lng":107.60791,"deleteAccess":true},"title":"Safira","content":"Neo soho","label":"Jakarta","status":"DONE","assignee":["[email protected]"],"assignedTo":{"_id":"641807adbfaea73910208b0f","name":"Leandro","email":"[email protected]","hubId":["64180853e480b10a631c8452"],"roleId":"64d2ebcd340ac136d87e96f4"},"assignedBy":"[email protected]","assignedTime":"2023-10-16T07:14:45+00:00","startTime":"2023-10-16T07:12:00+00:00","endTime":"2023-10-17T07:12:00+00:00","updatedTime":"2023-10-16T07:14:45+00:00","updatedBy":"[email protected]","createdBy":"[email protected]","createdFrom":"WEB","createdTime":"2023-10-16T07:13:31+00:00","doneBy":"[email protected]","doneCoordinate":"-6.17525,106.79028","doneTime":"2023-10-17T07:10:00+00:00","doneFrom":"MOBILE","openTaskTime":"2023-10-16T07:10:00+00:00","waitingTime":7,"travelDuration":1346.83,"duration":10,"distance":375,"eta":"10:03:34","etd":"11:43:22","assignedVehicleId":"6153defcbd80d354e0708a74","assignedVehicle":{"_id":"63870d38158a183a414a2a6b","assignee":"[email protected]","name":"Test Vehicle","speed":24,"workingTime":{"startTime":"09:00","endTime":"18:00","multiday":0}},"routePlannedOrder":1,"idleDuration":0,"expectedCoordinate":"-6.0091023,166.8726861","expectedDoneTime":"2023-10-17T07:10:00+00:00","createdCoordinate":"-6.179763,106.708670","useGeoLock":true,"geoLock":{"geolocation":"-8.2700558,111.7131245","radius":50},"geoLockTrigger":"onTaskStart","refId":"task01","idLocal":"6352736c628401059b37a2e2","orderIndex":169744041128541,"isSample":false,"doneOrder":3,"isLastDoneOrder":true,"inLocation":"2022-10-17T06:20:23+00:00","outLocation":"2022-10-17T06:20:23+00:00","travelDistance":20542.8,"taskType":"task","parentId":"64b4e719dc92e91ae936d664","subId":["64b4e719dc92e91ae936d665","64b4e719dc92e91ae936d666"],"workflow":{"_id":"workflow123","name":"3-Step Vehicle Inspection","steps":[{"order":1,"flowName":"Engine Check","flowId":"flow_engine_123"},{"order":2,"flowName":"Body Check","flowId":"flow_body_456"},{"order":3,"flowName":"Document Check","flowId":"flow_doc_789"}],"organizationId":"6153defcbd80d354e0708a74"},"workflowId":"workflow_vehicle_inspection_v2","histories":[{"_id":"652ce29b5180e397fd049174","action":"create","notes":"Created by John","changeData":{"flow":"Delivery","hubId":"615bb662bd32b7726709acd2","startTime":"2023-10-16T14:12:00.000+07:00","endTime":"2023-10-17T14:12:00.000+07:00","createdFrom":"WEB","assignee":[],"customerName-1":"Safira","customerAddress":"Neo soho jakarta","customerCoordinate":"-6.17525,106.79028","organization":{"_id":"63e083f9b934ff3dc2180132","name":"mileapp","email":"[email protected]"},"title":"Safira","content":"Neo soho jakarta","expectedCoordinate":"-6.17525,106.79028","organizationId":"6153defcbd80d354e0708a74","flowId":"632ac456c400337f183d14ff","status":"UNASSIGNED","hub":{"id":"64006d2da2b2125d925642d2","name":"bandung","lat":-6.91266,"lng":107.60791},"orderIndex":169744041128541,"createdBy":"[email protected]"},"createdAt":"2023-10-16T07:13:31.300000Z"}],"deviceInformation":{"os":"13"},"routingResultId":"65e05c0985a87f0f5a395fe2","parentTaskId":"65e05a37eed1c9235633a1b2","autoSplit":"Equal","splitNumber":"1/2"}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"openapi/public/openapi-full.json"},"subdomain":"mile-app","siteName":"Docs","title":"Task object - Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T03:19:00.581Z","originalFileLocation":"api-reference/objects/task-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Task object - Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docsy3.mile.app/api-reference/objects/task-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mile-app.mintlify.app/_mintlify/api/og/v2?division=Objects\u0026amp;title=Task+object\u0026amp;theme=d8f06ae19fc507e5db12c83f\u0026amp;signature=066f3a35551e6678f29db2f8fa5e98428e747f7c5eac82400cdadaeaae893a8c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Task object - Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mile-app.mintlify.app/_mintlify/api/og/v2?division=Objects\u0026amp;title=Task+object\u0026amp;theme=d8f06ae19fc507e5db12c83f\u0026amp;signature=066f3a35551e6678f29db2f8fa5e98428e747f7c5eac82400cdadaeaae893a8c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#02A8F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docsy3.mile.app/api-reference/objects/task-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/objects/task-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docsy3.mile.app/#organization\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://docsy3.mile.app#website\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docsy3.mile.app/api-reference/objects/task-object#webpage\",\"url\":\"https://docsy3.mile.app/api-reference/objects/task-object\",\"name\":\"Task object\",\"dateModified\":\"2026-10-01T03:19:00.581Z\",\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"},\"breadcrumb\":{\"@id\":\"https://docsy3.mile.app/api-reference/objects/task-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docsy3.mile.app/api-reference/objects/task-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Docs\",\"item\":\"https://docsy3.mile.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Task object\",\"item\":\"https://docsy3.mile.app/api-reference/objects/task-object\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docsy3.mile.app/api-reference/objects/task-object#apireference\",\"headline\":\"Task object\",\"name\":\"Task object\",\"url\":\"https://docsy3.mile.app/api-reference/objects/task-object\",\"mainEntityOfPage\":{\"@id\":\"https://docsy3.mile.app/api-reference/objects/task-object#webpage\"},\"dateModified\":\"2026-10-01T03:19:00.581Z\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Data Formats","href":"/api-reference/data-formats"},{"title":"Status Codes","href":"/api-reference/status-codes"}]},{"group":"Tools","pages":[{"group":"Short Token","pages":[{"title":"Generate Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/generate","href":"/api-reference/tools/short-token/generate-short-token"},{"title":"Resolve Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/resolve","href":"/api-reference/tools/short-token/resolve-short-token"}]}]},{"group":"Webhook","pages":[{"title":"How does it works","href":"/api-reference/webhooks/how-it-works"},{"title":"Delivery Attempts and Retries","href":"/api-reference/webhooks/delivery-attempts"},{"title":"Quick Response Requirement","href":"/api-reference/webhooks/quick-response"},{"title":"Failure Monitoring and Notification Process","href":"/api-reference/webhooks/failure-monitoring"},{"group":"Webhook","pages":[{"title":"Task events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook task-events","href":"/api-reference/webhooks/webhook/task-events"},{"title":"On data source created","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook data-source-created","href":"/api-reference/webhooks/webhook/on-data-source-created"},{"title":"Routing events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook routing-events","href":"/api-reference/webhooks/webhook/routing-events"},{"title":"Trip events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook trip-events","href":"/api-reference/webhooks/webhook/trip-events"}]}]},{"group":"Task","pages":[{"group":"Overview","pages":[{"title":"Task","href":"/api-reference/task/overview"},{"title":"Location History","href":"/api-reference/task/location-history-overview"},{"title":"Task Schedule","href":"/api-reference/task/task-schedule-overview"},{"title":"Overview","href":"/api-reference/activity/overview"}]},{"group":"Task","pages":[{"title":"Read tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks","href":"/api-reference/task/task/read-tasks"},{"title":"Read tasks gallery","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks-gallery","href":"/api-reference/task/task/read-tasks-gallery"},{"title":"Read task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/{task_id}","href":"/api-reference/task/task/read-task-by-id"},{"title":"Read public task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/public/{task_id}","href":"/api-reference/task/task/read-public-task-by-id"},{"title":"Read task tracking","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks/tracking","href":"/api-reference/task/task/read-task-tracking"},{"title":"Create task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task","href":"/api-reference/task/task/create-task"},{"title":"Create multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /tasks/bulk/","href":"/api-reference/task/task/create-multiple-tasks"},{"title":"Upload image for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{forRenameFile}","href":"/api-reference/task/task/upload-image-for-task"},{"title":"Upload video for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{forRenameFile}","href":"/api-reference/task/task/upload-video-for-task"},{"title":"Update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskid}","href":"/api-reference/task/task/update-task-by-id"},{"title":"Update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/#","href":"/api-reference/task/task/update-multiple-tasks"},{"title":"Move task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/move","href":"/api-reference/task/task/move-task-by-id"},{"title":"Assign task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/assign","href":"/api-reference/task/task/assign-task-by-id"},{"title":"Move multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/move","href":"/api-reference/task/task/move-multiple-tasks"},{"title":"Assign multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/assign","href":"/api-reference/task/task/assign-multiple-tasks"},{"title":"Partially update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/{taskId}","href":"/api-reference/task/task/partially-update-task-by-id"},{"title":"Delete multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /tasks/bulk","href":"/api-reference/task/task/delete-multiple-tasks"},{"title":"Partial update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /tasks/bulk","href":"/api-reference/task/task/partial-update-multiple-tasks"},{"title":"Delete task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/{id}","href":"/api-reference/task/task/delete-task-by-id"}]},{"group":"Location History","pages":[{"title":"Read location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-histories","href":"/api-reference/task/location-history/read-location-history"},{"title":"Read location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/{id}","href":"/api-reference/task/location-history/read-location-history-by-id"},{"title":"Read location history by token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/tracking/{token}","href":"/api-reference/task/location-history/read-location-history-by-token"},{"title":"Create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history","href":"/api-reference/task/location-history/create-location-history"},{"title":"Bulk create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/bulk","href":"/api-reference/task/location-history/bulk-create-location-history"},{"title":"Generate location history token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/generate-token","href":"/api-reference/task/location-history/generate-location-history-token"},{"title":"Update location history by email \u0026 createdTime","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/","href":"/api-reference/task/location-history/update-location-history-by-email-\u0026-createdtime"},{"title":"Update location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-location-history-by-id"},{"title":"Delete location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /location-history/{loc_history_id}","href":"/api-reference/task/location-history/delete-location-history-by-id"},{"title":"Update partially location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-partially-location-history-by-id"}]},{"group":"Task Schedule","pages":[{"title":"Read task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedules","href":"/api-reference/task/task-schedule/read-task-schedule"},{"title":"Read task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedule/{id}","href":"/api-reference/task/task-schedule/read-task-schedule-by-id"},{"title":"Create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedule","href":"/api-reference/task/task-schedule/create-task-schedule"},{"title":"Bulk create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedules/bulk","href":"/api-reference/task/task-schedule/bulk-create-task-schedule"},{"title":"Update task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-task-schedule-by-id"},{"title":"Delete task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/delete-task-schedule-by-id"},{"title":"Update partially task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-partially-task-schedule-by-id"}]}]},{"group":"Routing","pages":[{"group":"Overview","pages":[{"title":"Routing","href":"/api-reference/routing/overview"},{"title":"Vehicle","href":"/api-reference/routing/vehicle-overview"}]},{"group":"Vehicle","pages":[{"title":"Read vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicles","href":"/api-reference/routing/vehicle/read-vehicle"},{"title":"Read vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/read-vehicle-by-id"},{"title":"Update vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-vehicle-by-id"},{"title":"Delete vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/delete-vehicle-by-id"},{"title":"Update partially vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-partially-vehicle-by-id"},{"title":"Create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicle","href":"/api-reference/routing/vehicle/create-vehicle"},{"title":"Bulk create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicles/","href":"/api-reference/routing/vehicle/bulk-create-vehicle"},{"title":"Delete vehicle by Hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicles/{hubId}/hub","href":"/api-reference/routing/vehicle/delete-vehicle-by-hub"}]},{"group":"Routing","pages":[{"title":"Read routing results","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /results","href":"/api-reference/routing/routing/read-routing-results"},{"title":"Read routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}","href":"/api-reference/routing/routing/read-routing-result-by-id"},{"title":"Update routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}","href":"/api-reference/routing/routing/update-routing-result-by-id"},{"title":"Delete routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /result/{resultId}","href":"/api-reference/routing/routing/delete-routing-result-by-id"},{"title":"Update partially routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /result/{resultId}","href":"/api-reference/routing/routing/update-partially-routing-result-by-id"},{"title":"Route optimize","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing","href":"/api-reference/routing/routing/route-optimize"},{"title":"Dispatch routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /dispatch","href":"/api-reference/routing/routing/dispatch-routing-result"},{"title":"Reorder visits","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /reorder-visits","href":"/api-reference/routing/routing/reorder-visits"},{"title":"Read routing result history by result ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}/history","href":"/api-reference/routing/routing/read-routing-result-history-by-result-id"}]}]},{"group":"Flow","pages":[{"group":"Overview","pages":[{"title":"Flow","href":"/api-reference/flow/overview"},{"title":"Automation","href":"/api-reference/flow/automation-overview"}]},{"group":"Flow","pages":[{"title":"Read flows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flows","href":"/api-reference/flow/flow/read-flows"},{"title":"Read flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowId}","href":"/api-reference/flow/flow/read-flow-by-id"},{"title":"Read flow fields","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-fields","href":"/api-reference/flow/flow/read-flow-fields"},{"title":"Read flow components","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-components","href":"/api-reference/flow/flow/read-flow-components"},{"title":"Read flow component by flow name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/fields","href":"/api-reference/flow/flow/read-flow-component-by-flow-name"},{"title":"Generate example","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/task","href":"/api-reference/flow/flow/generate-example"},{"title":"Read flow histories","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-logs","href":"/api-reference/flow/flow/read-flow-histories"},{"title":"Create flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flow","href":"/api-reference/flow/flow/create-flow"},{"title":"Read flow versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flows/check-version","href":"/api-reference/flow/flow/read-flow-versions"},{"title":"Re-order flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow-reorder","href":"/api-reference/flow/flow/re-order-flow"},{"title":"Update flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flow_id}","href":"/api-reference/flow/flow/update-flow-by-id"},{"title":"Delete flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /flow/{flow_id}","href":"/api-reference/flow/flow/delete-flow-by-id"},{"title":"Restore flow by flow log ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flowId}/restore/{flowLogId}","href":"/api-reference/flow/flow/restore-flow-by-flow-log-id"}]},{"group":"Automation","pages":[{"title":"Read automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automations","href":"/api-reference/flow/automation/read-automation"},{"title":"Read log automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log","href":"/api-reference/flow/automation/read-log-automation"},{"title":"Read automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation/{automationId}","href":"/api-reference/flow/automation/read-automation-by-id"},{"title":"Create automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation","href":"/api-reference/flow/automation/create-automation"},{"title":"Retry bulk automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation-retries","href":"/api-reference/flow/automation/retry-bulk-automation"},{"title":"Update automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /automation/{automation_id}","href":"/api-reference/flow/automation/update-automation-by-id"},{"title":"Update partially automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation/{automation_id}","href":"/api-reference/flow/automation/update-partially-automation-by-id"},{"title":"Retry automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation-retry/{log_id}","href":"/api-reference/flow/automation/retry-automation-by-id"},{"title":"Delete automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /automation/{automation_id}/","href":"/api-reference/flow/automation/delete-automation-by-id"}]}]},{"group":"Workflow","pages":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/workflow/overview"}]},{"group":"Workflow","pages":[{"title":"Get All Workflows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /internal/workflows","href":"/api-reference/workflow/workflow/get-all-workflows"},{"title":"Create Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json post /internal/workflows","href":"/api-reference/workflow/workflow/create-workflow"},{"title":"Search Workflows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /internal/workflows/search","href":"/api-reference/workflow/workflow/search-workflows"},{"title":"Get Workflow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /workflow/{id}","href":"/api-reference/workflow/workflow/get-workflow-by-id"},{"title":"Update Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json put /workflow/{id}","href":"/api-reference/workflow/workflow/update-workflow"},{"title":"Delete Workflow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json delete /workflow/{id}","href":"/api-reference/workflow/workflow/delete-workflow"},{"title":"Get Field Mapping Data","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json get /workflow/{id}/steps/{stepOrder}/field-mapping-data","href":"/api-reference/workflow/workflow/get-field-mapping-data"},{"title":"Validate Field Mappings","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-workflow.json post /workflow/{id}/steps/{stepOrder}/validate-field-mappings","href":"/api-reference/workflow/workflow/validate-field-mappings"}]}]},{"group":"Data","pages":[{"group":"Overview","pages":[{"title":"Data","href":"/api-reference/data/overview"},{"title":"Data Source","href":"/api-reference/data/data-source-overview"},{"title":"Data Type","href":"/api-reference/data/data-type-overview"}]},{"group":"Data Source","pages":[{"title":"Read data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data","href":"/api-reference/data/data-source/read-data-source"},{"title":"Create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data","href":"/api-reference/data/data-source/create-data-source"},{"title":"Read data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-id"},{"title":"Read data source by dataTypeName and dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-datatypename-and-dataid"},{"title":"Read data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/hub/{hubId}/type/{dataTypeName}/{data_id}","href":"/api-reference/data/data-source/read-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk","href":"/api-reference/data/data-source/bulk-create-data-source"},{"title":"Bulk create or update data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk/upsert","href":"/api-reference/data/data-source/bulk-create-or-update-data-source"},{"title":"Update data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/{_id}","href":"/api-reference/data/data-source/update-data-source-by-id"},{"title":"Update data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/hub/{hub_id}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/update-data-source-by-hubid-datatypename-dataid"},{"title":"Update partially data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data/{data_id}","href":"/api-reference/data/data-source/update-partially-data-source-by-id"},{"title":"Delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/{data_id}/","href":"/api-reference/data/data-source/delete-data-source"},{"title":"Delete data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/hub/{hubId}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/delete-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /datas/bulk","href":"/api-reference/data/data-source/bulk-delete-data-source"},{"title":"Bulk patch data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /datas/bulk","href":"/api-reference/data/data-source/bulk-patch-data-source"}]},{"group":"Data Type","pages":[{"title":"Read data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types","href":"/api-reference/data/data-type/read-data-type"},{"title":"Read data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-type/{dataTypeId}/","href":"/api-reference/data/data-type/read-data-type-by-id"},{"title":"Create data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type","href":"/api-reference/data/data-type/create-data-type"},{"title":"Update data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-data-type-by-id"},{"title":"Delete data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data-type/{dataTypeId}","href":"/api-reference/data/data-type/delete-data-type-by-id"},{"title":"Update partially data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-partially-data-type-by-id"}]}]},{"group":"Setting","pages":[{"group":"Overview","pages":[{"title":"Setting","href":"/api-reference/setting/overview"},{"title":"User","href":"/api-reference/setting/user-overview"},{"title":"Team","href":"/api-reference/setting/team-overview"},{"title":"Role","href":"/api-reference/setting/role-overview"},{"title":"Hub","href":"/api-reference/setting/hub-overview"},{"title":"App Integration","href":"/api-reference/setting/app-integration-overview"},{"title":"Add-on","href":"/api-reference/setting/addon-overview"}]},{"group":"User","pages":[{"title":"Read user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /users","href":"/api-reference/setting/user/read-user"},{"title":"Read mine","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user","href":"/api-reference/setting/user/read-mine"},{"title":"Update partially user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user","href":"/api-reference/setting/user/update-partially-user"},{"title":"Read user by email","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/email/{email}","href":"/api-reference/setting/user/read-user-by-email"},{"title":"Read user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/{userId}","href":"/api-reference/setting/user/read-user-by-id"},{"title":"Update user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /user/{userId}","href":"/api-reference/setting/user/update-user"},{"title":"Update partially user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user/{userId}","href":"/api-reference/setting/user/update-partially-user-by-id"},{"title":"Read locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /members/locked","href":"/api-reference/setting/user/read-locked-user"},{"title":"Unlock locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/unlock","href":"/api-reference/setting/user/unlock-locked-user"},{"title":"Reset password user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/reset-password","href":"/api-reference/setting/user/reset-password-user"},{"title":"Delete user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /member/{userId}","href":"/api-reference/setting/user/delete-user"}]},{"group":"Team","pages":[{"title":"Read team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /teams","href":"/api-reference/setting/team/read-team"},{"title":"Read team by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /team/{teamId}","href":"/api-reference/setting/team/read-team-by-id"},{"title":"Create team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /team","href":"/api-reference/setting/team/create-team"},{"title":"Update team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /team/{teamId}/","href":"/api-reference/setting/team/update-team"},{"title":"Delete team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /team/{teamId}/","href":"/api-reference/setting/team/delete-team"}]},{"group":"Role","pages":[{"title":"Read role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /roles","href":"/api-reference/setting/role/read-role"},{"title":"Read role by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role/{roleId}","href":"/api-reference/setting/role/read-role-by-id"}]},{"group":"Hub","pages":[{"title":"Read hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hubs","href":"/api-reference/setting/hub/read-hub"},{"title":"Read hub by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hub/{hubId}/","href":"/api-reference/setting/hub/read-hub-by-id"},{"title":"Create hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /hub","href":"/api-reference/setting/hub/create-hub"},{"title":"Update hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /hub/{hubId}","href":"/api-reference/setting/hub/update-hub"},{"title":"Delete hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /hub/{hubId}","href":"/api-reference/setting/hub/delete-hub"}]},{"group":"App Integration","pages":[{"title":"Read App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integrations","href":"/api-reference/setting/app-integration/read-app-integration"},{"title":"Read App Integration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/read-app-integration-by-id"},{"title":"Create App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration","href":"/api-reference/setting/app-integration/create-app-integration"},{"title":"Update App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration/{appIntegrationId}/","href":"/api-reference/setting/app-integration/update-app-integration"},{"title":"Delete App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /app-integration/{appIntegrationId}/","href":"/api-reference/setting/app-integration/delete-app-integration"}]}]},{"group":"Import/Export","pages":[{"group":"Overview","pages":[{"title":"Import/Export","href":"/api-reference/importexport/overview"},{"title":"Data Import","href":"/api-reference/importexport/data-import-overview"},{"title":"Export Task","href":"/api-reference/importexport/export-task-overview"},{"title":"Export Config","href":"/api-reference/importexport/export-config-overview"},{"title":"Import Config","href":"/api-reference/importexport/import-config-overview"}]},{"group":"Export Task","pages":[{"title":"Get export log history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/export-log","href":"/api-reference/importexport/export-task/get-export-log-history"},{"title":"Export tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/export","href":"/api-reference/importexport/export-task/export-tasks"},{"title":"Export data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/export","href":"/api-reference/importexport/export-task/export-data-source"}]},{"group":"Data Import","pages":[{"title":"Import data source from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/import","href":"/api-reference/importexport/data-import/import-data-source-from-file"},{"title":"Read import monitoring records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring","href":"/api-reference/importexport/data-import/read-import-monitoring-records"},{"title":"Read import monitoring record by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring/{id}","href":"/api-reference/importexport/data-import/read-import-monitoring-record-by-id"}]},{"group":"Export Config","pages":[{"title":"Read export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-configs","href":"/api-reference/importexport/export-config/read-export-config"},{"title":"Read export config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-config/{exportConfigId}","href":"/api-reference/importexport/export-config/read-export-config-by-id"},{"title":"Create export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /export-config","href":"/api-reference/importexport/export-config/create-export-config"},{"title":"Update export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/update-export-config"},{"title":"Delete export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/delete-export-config"}]},{"group":"Import Config","pages":[{"title":"Read import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs","href":"/api-reference/importexport/import-config/read-import-config"},{"title":"Read import config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-config/{importConfigId}","href":"/api-reference/importexport/import-config/read-import-config-by-id"},{"title":"Create import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /import-config","href":"/api-reference/importexport/import-config/create-import-config"},{"title":"Update import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /import-config/{importConfigId}/","href":"/api-reference/importexport/import-config/update-import-config"},{"title":"Delete import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /import-config/{importConfigId}/","href":"/api-reference/importexport/import-config/delete-import-config"}]}]},{"group":"File","pages":[{"title":"Overview","href":"/api-reference/file/overview"},{"group":"File","pages":[{"title":"View file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-file.json get /file/view","href":"/api-reference/file/file/view-file"}]}]},{"group":"Auth","pages":[{"group":"Overview","pages":[{"title":"Multi-Organization","href":"/api-reference/auth/multi-organization-overview"}]},{"group":"Multi-Organization","pages":[{"title":"Get User Organizations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json get /organizations","href":"/api-reference/auth/multi-organization/get-user-organizations"},{"title":"Switch Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization/switch","href":"/api-reference/auth/multi-organization/switch-organization"},{"title":"Create Organization","description":"Create a new organization and automatically switch to it. The user becomes the owner of the new organization.\n\n**Requirements:**\n- User must be authenticated\n- User must have `create/organization` permission\n\n**Behavior:**\n- If user has an existing owned organization with hubs, hub fields are optional (will copy from source)\n- If user has no owned organization, hub fields (hubName, hubLat, hubLng) are required\n- If `copyDataFromFirstOrg` is true, copies configuration, hubs, and flows from user's first owned organization\n- Creates default flows from templates\n- Generates sample data (vehicles, data sources, tasks) via background job\n\n**Note:** After creation, the previous access token is revoked. You must use the new token returned in the response.","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization","href":"/api-reference/auth/multi-organization/create-organization"}]}]},{"group":"Objects","pages":[{"title":"Task object","href":"/api-reference/objects/task-object"},{"title":"Location history object","description":null,"href":"/api-reference/objects/location-history-object"},{"title":"Export Config object","href":"/api-reference/objects/export-config-object"},{"title":"Task Schedule object","href":"/api-reference/objects/task-schedule-object"},{"title":"Vehicle object","href":"/api-reference/objects/vehicle-object"},{"title":"Routing object","href":"/api-reference/objects/routing-object"},{"title":"Flow object","href":"/api-reference/objects/flow-object"},{"title":"Workflow object","href":"/api-reference/objects/workflow-object"},{"title":"Automation object","href":"/api-reference/objects/automation-object"},{"title":"Data source object","href":"/api-reference/objects/data-source-object"},{"title":"Data type object","href":"/api-reference/objects/data-type-object"},{"title":"User object","href":"/api-reference/objects/user-object"},{"title":"Role object","href":"/api-reference/objects/role-object"},{"title":"Hub object","href":"/api-reference/objects/hub-object"},{"title":"Team object","href":"/api-reference/objects/team-object"},{"title":"Add-on object","href":"/api-reference/objects/addon-object"}]}]},{"tab":"Internal API","hidden":true,"pages":[{"title":"Internal API","href":"/api-reference-internal/introduction"}]}]},"basePath":"","title":"Task object - Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}