Attribute | Example |
---|---|
id Form identifier |
"id": 36120 |
name Form name |
"name": "Payments" |
steps Workflow steps list. An object whose keys are step numbers, and the values are their names/span> |
"steps": { "1": "Manager", "2": "Accounting", "4": "CEO" } |
fields An array of form fields |
"fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam" }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25 } ] |
deleted_or_closed Deleted or closed form attribute |
"deleted_or_closed": false |
print_forms Print forms array |
"print_forms": [ { "print_form_id": 2633, "print_form_name": "templateA.docx" }, { "print_form_id": 2645, "print_form_name": "templateB.xlsx" } ] |
Attribute | Example |
---|---|
id Task identifier |
"id": 11610 |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"create_date": "2017-08-20T12:31:14Z" |
last_modified_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
close_date Date format: YYYY-MM-DDThh:mm:ssZ |
"close_date": "2017-08-23T10:20:11Z" |
current_step |
"current_step": 1 |
fields An array of form fields |
"fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam" }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25 } ] |
Attribute | Example |
---|---|
id Task identifier |
"id": 11610 |
text Task text |
"text": "Help with printer" |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
last_modified_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
author Task author |
"author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
due_date The task due date. Date format: YYYY-MM-DD |
"due_date": "2018-03-21" |
due The task due date with time. Date format: YYYY-MM-DDThh:mm:ssZ |
"due": "2018-03-22T03:22:15Z" |
duration The duration of the event in minutes |
"duration": 120 |
close_date Date format: YYYY-MM-DDThh:mm:ssZ |
"close_date" : "2018-02-14T12:44:25" |
current_step |
"current_step": 1 |
list_ids An array of list identifiers |
"list_ids": [2646, 30304, 65349] |
responsible Responsible for the task |
"responsible": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
participants An array of task participants |
"participants": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } ] |
subscribers An array of task subscribers that contains persons and their approval choices. |
"subscribers": [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ] |
attachments An array of files attached to the tasks |
"attachments": [ { "id": 6647, "name": "contract-142.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC3", "url": "https://pyrus.com/services/attachment?id=6647", "version": 2, "root_id": 17562 } ] |
parent_task_id Parent task identifier. |
"parent_task_id": 5444 |
linked_task_ids An array of linked task identifiers. |
"linked_task_ids": [12334, 44355, 72345] |
comments An array of task comments |
"comments": [ { "id": 13767, "text": "Help with printer", "create_date": "2017-08-17T15:32:11Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } } ] |
Attribute | Example |
---|---|
id Comment id |
"id": 176324 |
text Comment text |
"text": "this is my comment" |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"create_date": "2017-08-23T13:12:27Z" |
author Comment author |
"author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
added_list_ids An array of lists to which the task was added |
"added_list_ids": [1374, 1444] |
removed_list_ids An array of lists from which the task was removed |
"removed_list_ids": [1374] |
reassigned_to The person to whom the task was reassigned |
"reassigned_to": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
approval_choice User's approval choice possible values: approved, rejected, revoked, acknowledged |
"approval_choice": "approved" |
participants_added An array of people added to the task |
"participants_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" }, ] |
participants_removed An array of people removed from the task |
"participants_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_added An array of subscribers added to the task. |
"subscribers_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_removed An array of subscribers removed from the task. |
"subscribers_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_rerequested An array of subscribers to be reconciled. |
"subscribers_rerequested": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
due_date The task due date. Date format: YYYY-MM-DD |
"due_date": "2018-03-21" |
due The task due date with time. Date format: YYYY-MM-DDThh:mm:ssZ |
"due": "2018-03-22T03:22:15Z" |
duration The duration of the event in minutes |
"duration": 120 |
attachments An array of files attached to the comment |
"attachments": [ { "id": 6652, "name": "contract-147.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC4", "url": "https://pyrus.com/services/attachment?id=6652", "version": 2, "root_id": 17562 } ] |
action Action on the task. Possible values: finished, reopened |
"action": "finished" |
spent_minutes Spent time in minutes |
"spent_minutes": 30 |
Attribute | Example |
---|---|
id Task identifier |
"id": 11610 |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
last_modified_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
author Task author |
"author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
close_date Date format: YYYY-MM-DDThh:mm:ssZ |
"close_date" : "2018-02-14T12:44:25" |
form_id Form template identifier |
"form_id": 1474 |
approvals An array of approval steps. Each step contains people and their choices |
"approvals": [ [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ], [ { "person": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "approval_choice": "waiting" } ] ] |
subscribers An array of task subscribers that contains persons and their approval choices. |
"subscribers": [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ] |
attachments An array of files attached to the task |
"attachments": [ { "id": 6647, "name": "contract-142.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC3", "url": "https://pyrus.com/services/attachment?id=6647", "version": 2, "root_id": 17562 } ] |
parent_task_id Parent task identifier. |
"parent_task_id": 5444 |
linked_task_ids An array of linked task identifiers. |
"linked_task_ids": [12334, 44355, 72345] |
fields An array of form fields |
"fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam" }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25 } ] |
comments An array of task comments |
"comments": [ { "id": 13767, "text": "Help with printer", "create_date": "2017-08-17T15:32:11Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } } ] |
Attribute | Example |
---|---|
id Comment identifier |
"id": 176324 |
text Comment text |
"text": "this is my comment" |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"create_date": "2017-08-23T13:12:27Z" |
author Comment author |
"author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
added_list_ids An array of lists to which the task was added |
"added_list_ids": [1374, 1444] |
removed_list_ids An array of lists from which the task was removed |
"removed_list_ids": [1374] |
reassigned_to The person to whom the task was reassigned |
"reassigned_to": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
approval_choice User's approval choice possible values: approved, rejected, revoked, acknowledged |
"approval_choice": "approved" |
changed_step The step number to which the task was moved. Numbering starts from one |
"changed_step": 2 |
approvals_added An array of added approval steps. Each step is an array containing the person and the step number |
"approvals_added": [[ { "person": { "id": 1733, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "step": 1 }, { "person": { "id": 1732, "first_name": "Sarah", "last_name": "Parker", "email": "Parker@gmail.com", "type": "user" }, "step": 1 } ], [ { "person": { "id": 1731, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "step": 2 } ]] |
approvals_removed An array of removed approval steps. Each step is an array containing the person and the step number |
"approvals_removed": [[ { "person": { "id": 1733, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "step": 1 } ]] |
approvals_rerequested An array of rerequested approval steps. Each step is an array containing the person and the step number |
"approvals_rerequested": [[ { "person": { "id": 1732, "first_name": "Sarah", "last_name": "Parker", "email": "Parker@gmail.com", "type": "user" }, "step": 1 } ]] |
subscribers_added An array of subscribers added to the task. |
"subscribers_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_removed An array of subscribers removed from the task. |
"subscribers_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_rerequested An array of subscribers to be reconciled. |
"subscribers_rerequested": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
comment_as_roles List of roles on behalf of which the task was commented |
"comment_as_roles": [ { "id": 288556, "name": "Role1" } ] |
field_updates An array of updated form fields |
"field_updates": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Moscow" } ] |
due_date The task due date. Date format: YYYY-MM-DD |
"due_date": "2018-03-21" |
due The task due date with time. Date format: YYYY-MM-DDThh:mm:ssZ |
"due": "2018-03-22T03:22:15Z" |
duration The duration of the event in minutes |
"duration": 120 |
attachments An array of files attached to the comment |
"attachments": [ { "id": 6652, "name": "contract-147.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC4", "url": "https://pyrus.com/services/attachment?id=6652", "version": 2, "root_id": 17562 } ] |
action Action on the task. Possible values: finished, reopened |
"action": "finished" |
channel External channel |
"channel": { "type": "email", "from": { "email": "John@gmail.com" } } |
spent_minutes Spent time in minutes |
"spent_minutes": 30 |
Attribute | Example |
---|---|
type Channel type Possible values: email, telegram, facebook, vk, viber, mobile_app, web_widget, moy_sklad, zadarma, amo_crm |
"type": "email" |
to Receiver name. Only for outgoing comments. Consists of the property "email" (for the email channel) or "name" (for the other channels) |
"to": { "email": "John@gmail.com" } |
from Sender name. Only for incoming comments. Consists of the property "email" (for the email channel) or "name" (for the other channels) |
"from": { "name": "John Doe" } |
Attribute | Example |
---|---|
catalog_id Catalog identifier |
"catalog_id": 422 |
catalog_headers An array of catalog headers. Possible column types: workflow, text |
"catalog_headers": [ { "name": "City", "type": "text" } { "name": "Street", "type": "text" } ] |
items An array of catalog items |
"items": [ { "item_id": 1385, "values": [ "Costa Mesa", "2130 Fulton Streen" ] }, { "item_id": 1389, "values": [ "Norwalk", "650 Davis Street" ] } ] |
Attribute | Example |
---|---|
id Organization identifier |
"id": 2181 |
name Organization name |
"name": "My Organization" |
persons An array of organization members |
"persons": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } ] |
persons An array of roles in the organization |
"roles": [ { "id": 1733, "name": "Some Role", "member_ids": [1725, 1733], "type": "role" } ] |
Attribute | Example |
---|---|
id Task list identifier |
"id": 1352 |
name Task list name |
"name": "Branch offices" |
children And array of sublists |
"children": [ { "id": 1465, "name": "Moscow" }, { "id": 3763, "name": "San Francisco" } ] |
Attribute | Example |
---|---|
id Task identifier |
"id": 11610 |
create_date Date format: YYYY-MM-DDThh:mm:ssZ |
"create_date": "2017-08-20T12:31:14Z" |
last_modified_date Date format: YYYY-MM-DDThh:mm:ssZ |
"last_modified_date": "2017-08-23T10:20:11Z" |
close_date Date format: YYYY-MM-DDThh:mm:ssZ |
"close_date": "2017-08-23T10:20:11Z" |
author Task author |
"author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
responsible Responsible for the task |
"responsible": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
text Task text |
"text": "Help with printer" |
Attribute | Example |
---|---|
id User identifier |
"id": 4221 |
first_name User first name |
"first_name": "John" |
last_name User last name |
"last_name": "Snow" |
email User email address |
"email": "John@gmail.com" |
type User type |
"type": "user" |
department_id* User department identifier |
"department_id": "113" |
department_name* User department name |
"department_name": "Marketing" |
* - these fields are using only in get contacts response.
Attribute | Example |
---|---|
id Role id |
"id": 422 |
name Role name |
"name": "TechSupport" |
banned Is the role banned |
"banned": true |
member_ids An array of role members |
"member_ids": [ 1732, 6307, 4333 ] |
Attribute | Example |
---|---|
person_id Person identifier |
"person_id": 1732 |
first_name Person first name |
"first_name": "Jane" |
last_name Person last name |
"last_name": "Doe" |
email Person email address |
"email": "jane.doe@gmail.com" |
locale Person locale |
"locale": "en-US" |
organization_id Organization identifier |
"organization_id": 1834 |