v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Contacts List

This method allows to get a list of contacts in the account

get/api/v4/contacts

Query parameters

withstring

This parameter takes a string which may consist of several values separated by commas.

pageinteger

Sample page

limitinteger

The number of the entities returned in the response of one request (limit – 250)

querystring

String or integer. Search query will perform a search by custom fields values.

order[updated_at]'asc' | 'desc'

List elements sorting

order[id]'asc' | 'desc'

List elements sorting

filter[id][]integer[]

Filter by contact ID

filter[name][]string[]

Filter by contact name

filter[created_by][]integer[]

Filter by ID of the user who added the contact(s).

filter[updated_by][]integer[]

Filter by ID of the user who updated the contact last.

filter[responsible_user_id][]integer[]

Filter by ID of the contact responsible user

filter[updated_at][from]integer

Filter by the date in Unix Timestamp format when the contact was updated. As a response you will get all the contacts updated after the date.

filter[updated_at][to]integer

Filter by the date in Unix Timestamp format when the contact was updated. As a response you will get all the contacts updated before the date.

filter[closest_task_at][from]integer

Filter contacts by the date in Unix Timestamp format of the task closest to completion.

filter[closest_task_at][to]integer

Filter contacts by the date in Unix Timestamp format of the task closest to completion.

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/contacts"
    }
  },
  "_embedded": {
    "contacts": [
      {
        "id": 406322,
        "name": "Sam",
        "first_name": "Sam",
        "responsible_user_id": 8375357,
        "created_by": 8375357,
        "updated_by": 8375357,
        "created_at": 1686670710,
        "updated_at": 1686670710,
        "custom_fields_values": [
          {
            "field_id": 178382,
            "field_name": "Phone",
            "field_code": "PHONE",
            "field_type": "multitext",
            "values": [
              {
                "value": "19651796212",
                "enum_id": 126290,
                "enum_code": "WORK"
              }
            ]
          }
        ],
        "account_id": 31361463,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/contacts/406322"
          }
        },
        "_embedded": {
          "companies": [
            {
              "id": 406320,
              "_links": {
                "self": {
                  "href": "https://devteam.kommo.com/api/v4/companies/406320"
                }
              }
            }
          ]
        }
      }
    ]
  }
}