Retrieves a list of deal contacts.

Method	get.deal_contacts
API version	—
Description	Retrieves a list of deal contacts.

Available to: Agents and clients

Request parameters

Name	Type	Required	Description
access_token	string	yes	Access token used to authenticate the request.
user_id	number	no	Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	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 when the contact was created in the CRM, in YYYY-MM-DD hh:mm:ss format.
phone_numbers	array		yes		Contact phone numbers.
emails	array		yes		Contact email addresses.
component	enum	amocrm, bitrix, dataapi	yes	yes	Source integration through which the contact was imported.

Example request

{
  "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"
    ]
  }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": [
            {
                "ext_id": "string",
                "name": "string",
                "created_date_time": "iso8601",
                "phone_numbers": ["string"],
                "emails": ["string"]
            }
        ],
        "metadata": "object"
    }
}

Possible errors

See the "Errors for get methods" section.