| Method | get.deals_history |
|---|---|
| Description | Getting transaction history |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the "get.customer_users" method |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering Criteria" |
fields |
array | no | See "View of Returned Data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Title | Type | Filtering | Sorting | Description |
|---|---|---|---|---|
ext_id |
string | yes | yes | External deal ID |
name |
string | yes | Transaction name | |
created_date_time |
iso8601 | yes | yes | Date and time of transaction creation |
closed_date_time |
iso8601 | yes | yes | Transaction closing date and time |
modified_stage_date_time |
iso8601 | yes | yes | Date and time of transition of the transaction to the current stage |
tag_ext_ids |
array | yes | Tag IDs | |
main_contact_ext_id |
string | yes | yes | Main contact of the transaction |
employee_ext_id |
string | yes | Responsible employee for the transaction | |
revenue |
number | yes | yes | Transaction proceeds |
sales_funnel_ext_id |
string | yes | yes | Sales Funnel ID |
stage_ext_id |
string | yes | yes | Sales Funnel Stage ID |
comments |
string | no | Commentary on the transaction | |
source |
string | yes | yes | Deal Source |
is_generated |
boolean | yes | Automatically generated missed deal step | |
source |
string | yes | yes | Deal Source |
communication_id |
number | yes | yes | Case ID |
communication_type |
string | yes | yes | type of appeal |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.deals_history", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
} }
### JSON response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": [
{
"ext_id": "string",
"name": "string",
"created_date_time": "iso8601",
"closed_date_time": "iso8601",
"modified_stage_date_time": "iso8601",
"contact_ext_ids": [
"string"
],
"tag_ext_ids": [
"string"
],
"employee_ext_id": "string",
"revenue": "number",
"sales_funnel_ext_id": "string",
"stage_ext_id": "string",
"comments": "string",
"source": "string",
"is_generated": "boolean",
"communication_id": "number",
"communication_type": "string"
}
],
"metadata": "object"
}
}
List of returned errors
See the section "List of errors for methods with the verb get"