Common request records

These records are reused across different API calls.

Address

Field Type JSON type Required Can be null Description

formatted

String

String

No

No

Full address string. Limited to 5000 characters

geolocation

Geolocation

Object

No

No

Full address as one string

apartment

String

String

No

Yes

Apartment. Limited to 50 characters

floor

String

String

No

Yes

Floor. Limited to 50 characters

entrance_no

String

String

No

Yes

Entrance. Limited to 50 characters

description

String

String

Yes

Yes

Optional string description. It usually contains some information helping locating the site. Limited to 500 characters

Existing client

Reference a client by uuid or external_id. These fields are mutually exclusive.

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Client identifier

external_id

String

String

No

No

Client identifier in an external system

New client

Client is either an individual person or an organization.

Organization

All fields are optional except for organization_name and organization which must be true.

Field Type JSON type Required Can be null Description

organization

Boolean

Boolean

Yes

No

Must be true

organization_name

String

String

Yes

No

Organization name. Limited to 5000 characters

external_id

String

String

No

No

External ID

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

Individuals

All fields are optional except for organization which must be false. Additionally, at least one of first_name, last_name, and middle_name must not be empty.

Field Type JSON type Required Can be null Description

organization

Boolean

Boolean

Yes

No

Must be false

first_name

String

String

No

Yes

First name. Up to 50 characters

last_name

String

String

No

Yes

Last name. Up to 50 characters

middle_name

String

String

No

Yes

Middle name. Up to 50 characters

external_id

String

String

No

No

External ID

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

Existing site

Reference a site by uuid or external_id. These fields are mutually exclusive.

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Site identifier

external_id

String

String

No

No

Site identifier in an external system

New site

All fields are optional except for name.

Field Type JSON type Required Can be null Description

name

String

String

Yes

No

Site name. Up to 300 characters

external_id

String

String

No

Yes

External ID

description

String

String

No

Yes

Text describing the site. Up to 1000 characters

client

Existing client

Object

No

Yes

Reference to a client

address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

Assignee

Job assignee is either a single worker or a team. worker and team keys are mutually exclusive.

Field Type JSON type Required Can be null Description

worker

Record

Object

No

No

worker.uuid

UUID

String

No

No

Worker identifier

worker.email

Email

String

No

No

Emails are unique, it is possible to use them for referencing workers

team

Record

Object

No

No

team.uuid

UUID

String

No

No

Team identifier

team.name

String

String

No

No

Team names are unique

Multiple assignee

Job assignee. A job can have one or several assignees. One assignee from the list must have "edit" access.

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Worker identifier

access

String

String

No

No

Either edit or view

Job template

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Template identifier

name

String

String

No

No

Template name

Job type

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Job type identifier

code

String

String

No

No

Job type name

Contact

Field Type JSON type Required Can be null Description

name

String

String

No

Yes

Contact name. Limited to 50 characters

value

String

String

No

Yes

Contact string. Limited to 50 characters.
For adding multiple phone numbers add multiple contact records. Bear in mind, each contact is displayed as a separate dial button for the field worker

type

String

String

Yes

No

Only "phone" value is supported at the moment

Resolution

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Resolution identifier

name

String

String

No

No

Resolution name

Territory

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Territory identifier

name

String

String

No

No

Territory name

Skill

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Skill identifier

name

String

String

No

No

Skill name

Unit

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Unit identifier

name

String

String

No

No

Unit name

Category

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Category identifier

name

String

String

No

No

Category name

Dictionary value

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Dictionary item identifier

name

String

String

No

No

Name of dictionary item

Custom field

To set a value of a custom field, pass either its uuid or name. You can get these values from the job template response.

Field Type JSON type Required Can be null Description

uuid

UUID

String

No

No

Field identifier

name

String

String

No

No

Field name

value

Mixed

Mixed

Yes

No

value type depends on data_type value of the field
Table 1. value format depending on data_type
data_type JSON type of value Can be null Description

string

String

Yes

dictionary

Dictionary value

Yes

Dictionary value referenced by uuid or name

attachment

File value

Yes

File value

Field Type JSON type Required Can be null Description

name

String

String

Yes

No

File name

base64_content

String

String

Yes

No

Base64-encoded file content