| Method | get.deal_contacts |
|---|---|
| Description | Getting a list of contacts |
| 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 | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
ext_id |
string | yes | yes | External Contact ID | |
name |
string | yes | yes | Contact name | |
created_date_time |
iso8601 | no | Date and time the contact was created in CRM (YYYY-MM-DD hh:mm:ss) | ||
emails |
array | yes | The contact's email address. | ||
component |
enum | amocrm, bitrix, dataapi |
yes | yes | Method of obtaining transaction contact |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.deal_contacts", "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",
"phone_numbers": ["string"],
"emails": ["string"]
}
],
"metadata": "object"
}
}
List of returned errors
See the section "List of errors for methods with the verb get"