NAV
json

Introduction

TASKER API is RESTful and built on HTTP.

All TASKER clients can use an API. All you need is to request an API key and sandbox password by writing an email support@taskertools.com.

Sandbox

Every client has it’s own API sandbox. To access a sandbox, please visit https://YOUR_DOMAIN.taskertools.com/client/doc.

Data format

TASKER API supports JSON and XML formats.

You need to define necessary format in the request Content-Type and Accept headers.

Content-Type: application/json

Accept: application/json

Base URL

All requests to TASKER API should start with https://YOUR_DOMAIN.taskertools.com/client/api/v1/

Authentication

TASKER API uses API keys to allow access to API. API key should be included in all API requests in a header.

Authorization: Bearer <YOUR_API_KEY>

Pagination and Filter

TASKER API by default returns 100 items per page.

Every item has field “version”. It stores timestamp of the latest item modification date. If you need to retrieve

GUID

Object entity return example:

{
    "guid": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34",
    "version": "1450682195",
    "title": "Object #1",
    "serialNumber": "abc123",
    "client": "4100cdb2-c6a9-6dba-92f5-e1536d3202ca",
    "...": "..."
}

To link your system data with TASKER data, we implemented “guid” field in every entity.

You will get item GUID in the response content, after you create a new item, or by fetching list of existing items.

All item relations are also returned as GUID’s

Date format and time zone

DateTime format fields on TASKER API return and accept date only in ISO8601 format.

2005-08-15T15:52:01+0000

TASKER API return DateTime format fields in UTC time zone.

Entity/Clients

Get all Clients

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all clients ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/clients

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Client

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific client.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/clients/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Company title
address string ~
city string ~
phone string ~
email string ~
note text Some notes about client
companyCode string ~
companyVatCode string ~
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Client

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new client.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/clients

Update an existing Client

This endpoint updates an existing client.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/clients/<GUID>

Entity/Files

Get all Files

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "originalName": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "originalName": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all files ordered by version ascending.

Files can be attached to Tasks from TASKER admin panel or app.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/files

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing File

Default JSON structure:

{
    "guid": "",
    "version": "",
    "originalName": "",
    "...": "..."
}

This endpoint retrieves a specific file.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/files/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
originalName string File original name
path string File name on server
checksum string File MD5 checksum
contentLength int File size in bytes
task string Task GUID which file is attached to
created DateTime Item creation date
updated DateTime Item update date

Download File

This endpoint retrieves a specific file stream.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/files/<GUID>/download

Entity/Images

Get an existing Image

Default JSON structure:

{
    "guid": "",
    "path": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific image.

Images can be attached while creating notes on the app.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/images/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
path string Image name on server
contentLength int Image size in bytes
created DateTime Item creation date
updated DateTime Item update date

Download Image

This endpoint retrieves a specific image stream.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/images/<GUID>/download

Entity/Material Types

Get all Material Types

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all material types ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/material_types

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Material Type

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific material type.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/material_types/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Material type title
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Material Type

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new material type.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/material_types

Update an existing Material Type

This endpoint updates an existing material type.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/material_types/<GUID>

Entity/Materials

Get all Materials

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all materials ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/materials

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Material

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific material.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/materials/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Material title (empty if standartizedMaterial is defined)
serialNumber string ~
vat decimal ~
currency string Currency in ISO4217 format
amount decimal Amount of used material
rate int Unit price in cents
price int rate * amount (in cents)
priceWithVat int price + (price * vat / 100) (in cents)
sfNumber string Invoice number (if user purchased item by him self)
selfCost string Material self cost (in cents)
materialType string Material Type GUID
standartizedMaterial string Standartized Material GUID
object string Object GUID
task string Task GUID
user string User GUID
debited bool Debited flag
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Entity/Notes

Get all Notes

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all notes ordered by version ascending.

Notes are created by app user while working on specific Task.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/notes

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Note

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific note.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/notes/<GUID>

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title text Note text
visible bool true if Note is visible for client
image string Image GUID
task string Task GUID
user string User GUID
object string Object GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Entity/Objects

Get all Objects

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all objects ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/objects

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Object

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific object.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/objects/<GUID>

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Object title
serialNumber string ~
apartmentNumber string ~
address string ~
city string ~
longitude string In Decimal degrees (54.898247)
latitude string In Decimal degress (23.898371)
note text Some notes about object
distance int Distance from office in meters
signatureCode string Code to finish Task
objectCode string Code to start Task
client string Client GUID
responsiblePerson string Responsible Person GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Object

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new object.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/objects

Update an existing Object

This endpoint updates an existing object.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/objects/<GUID>

Entity/Offices

Get all Offices

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all offices ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/offices

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Office

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific office.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/offices/<GUID>

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Object title
address string ~
longitude string In Decimal degrees (54.898247)
latitude string In Decimal degress (23.898371)
phone string ~
email string ~
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Office

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new office.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/offices

Update an existing Office

This endpoint updates an existing office.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/offices/<GUID>

Entity/Place Records

Get all Place Records

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "isScanned": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "isScanned": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all place records ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/place_records

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Place Record

Default JSON structure:

{
    "guid": "",
    "version": "",
    "isScanned": "",
    "...": "..."
}

This endpoint retrieves a specific place record.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/place_records/<GUID>

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
isScanned bool ~
scanTime DateTime Place Record scan date (null if isScanned = false)
place string Client GUID
task string Task GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Entity/Places

Get all Places

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all places ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/places

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Place

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific place.

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Place title
scanCode string Place code
note string Note about the place (e.g. “On the right side of…”)
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/places/<GUID>

Create a new Place

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new place.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/places

Update an existing Place

This endpoint updates an existing place.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/places/<GUID>

Entity/Responsible Persons

Get all Responsible Persons

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "name": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "name": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all responsible persons ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/responsible_persons

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Responsible Person

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific responsible person.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/responsible_persons/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
firstName string ~
lastName string ~
phone decimal ~
email string ~
note text ~
client string Client GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Responsible Person

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "name": "",
    "...": "..."
}

This endpoint creates a new responsible person.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/responsible_persons

Update an existing Responsible Person

This endpoint updates an existing responsible person.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/responsible_persons/<GUID>

Entity/Standartized Materials

Get all Standartized Materials

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all standartized materials ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_materials

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Standartized Material

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific standartized material.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_materials/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Standartized material title
serialNumber string ~
materialType string Material type GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Standartized material

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new standartized material.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_materials

Update an existing Standartized material

This endpoint updates an existing standartized material.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_materials/<GUID>

Entity/Standartized Works

Get all Standartized Works

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all standartized works ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_workss

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Standartized Work

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific standartized work.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_works/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Standartized work title
rate int Hour price in cents
nightRate int Hour price in cents
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Standartized work

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new standartized work.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_works

Update an existing Standartized work

This endpoint updates an existing standartized work.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/standartized_works/<GUID>

Entity/Task Requests

Get all Task Requests

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all task requests ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_requests

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Task request

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific task request.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_requests/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string ~
description text ~
client string Client GUID
object string Object GUID
createdBy string User GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Task request

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new task request.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_requests

Entity/Task Types

Get all Task types

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all task types ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_types

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Task type

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific task type.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_types/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Task type title
mailList text List of additional summary receivers (seprated by “;” “,” or “ ”)
requireObjectCode bool ~
requireSignatureCode bool ~
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Create a new Task type

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new task type.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_types

This endpoint updates an existing task type.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/task_types/<GUID>

Entity/Tasks

Get all Tasks

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all tasks ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Task

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific task.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Task title
clientName string Person name who signed finished Task
clientEmail string Person email who signed finished Task
rating int Rating by client (1 - bad, 2 - average, 3 - bad)
agreement bool true if client agreed
signatureType int (0 - no signature, 1 - default signature, 2 - signed with signature code)
signatureFile string Signature path on server
description text Task description
abortMessage string ~
clientNote text Note written by client
clientNoteReply text Reply to client note by administrator
distance int Distance in meters
workPrice int Total price of all Task works in cents
workPriceWithVat int workPrice + (workPrice * vat / 100)
routePrice int Total price of all trips to Task object in cents
routePriceWithVat int routePrice + (routePrice * vat / 100)
materialPrice int Total price of all Task materials in cents
materialPriceWithVat int materialPrice + (materialPrice * vat / 100)
finalPrice int routePrice + workPrice + materialPrice
finalPriceWithVat int workPriceWithVat + routePriceWithVat + materialPriceWithVat
vat decimal ~
currency string Currency in ISO4217 format
status int Current Task status
stopStatusMessage text Message entered by worker in order to temporary stop Task
plannedTime DateTime ~
plannedEndTime DateTime ~
fetched bool true if Task was fetched by worker device
time DateTime Task start date
ended DateTime Task end date
pastDue bool If task was started not in time
duration int Total duration of all Task works in minutes
billStatus bool true if client was billed
billDate DateTime ~
reassigned bool true if Task was reassigned to other user
filesExists bool true if Task has files
user string User GUID
formerUser string User GUID
assignee string User GUID
taskType string Task Type GUID
object string Object GUID
client string Client GUID
taskRequest string Task Request GUID or null
createdBy string User GUID
requireObjectCode bool ~
requireSignature bool ~
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Status map:

Status Description
100 Inactive
101 Synced with app
102 Unassigned
200 In progress
300 Stopped
301 Stopped due to end of working day
302 Stopped due to urgent task
303 Stopped with remark
400 Done
401 Done with note
500 Unsigned
501 Not synced
600 Aborted

Get an existing Task with all relations

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "...",
    "materials": [],
    "works": [],
    "notes": [],
    "placeRecords": [],
    "files": []
}

This endpoint retrieves a specific Task with Materials, Works, Notes, Place records and Files.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks/<GUID>/relations

Get an existing Task summary

This endpoint retrieves a specific Task summary in PDF format.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks/<GUID>/summary

Create a new Task

Default response JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint creates a new task.

HTTP Request

POST https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks

Update an existing Task

This endpoint updates an existing task.

HTTP Request

PUT https://YOUR_DOMAIN.taskertools.com/client/api/v1/tasks/<GUID>

Entity/Users

Get all Users

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "name": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "name": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all users ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/users

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing User

Default JSON structure:

{
    "guid": "",
    "version": "",
    "name": "",
    "...": "..."
}

This endpoint retrieves a specific user.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/users/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
name string ~
surname string ~
email decimal ~
roles string User role
client string Client GUID
office string Office GUID
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Entity/Works

Get all Works

Default JSON structure:

{
    "next_page": 0,
    "items": [
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        },
        {
            "guid": "",
            "version": "",
            "title": "",
            "...": "..."
        }
    ]
}

This endpoint retrieves all works ordered by version ascending.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/works

Query Parameters

Parameter Required Format Description
version false timestamp Timestamp to filter data.
page false integer Page number.

Get an existing Work

Default JSON structure:

{
    "guid": "",
    "version": "",
    "title": "",
    "...": "..."
}

This endpoint retrieves a specific work.

HTTP Request

GET https://YOUR_DOMAIN.taskertools.com/client/api/v1/works/<GUID>

Default fields:

Field Format Description
guid string Unique item identifier
version timestamp Last update time (set by server)
title string Work title (empty if standartizedWork is defined)
duration int Work duration in minutes
vat decimal ~
currency string Currency in ISO4217 format
rate int Price per hour
price int rate * duration (in cents)
priceWithVat int price + (price * vat / 100) (in cents)
description text Invoice number (if user purchased item by him self)
standartizedWork string Standartized Work GUID
object string Object GUID
task string Task GUID
user string User GUID
debited bool Debited flag
created DateTime Item creation date
updated DateTime Item update date
deleted bool Archive flag

Response codes

Status Code Description
200 OK – The request has succeeded.
201 Created – Item created successfully.
204 No Content – Item updated successfully.
400 Bad Request – Your data is invalid.
401 Unauthorized – Your API key is wrong.
404 Not Found – URL or entity does not exits.
500 Internal Server Error – We had a problem with our server. Try again later.