v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Lista de contactos

Este método permite obtener una lista de contactos en la cuenta.

get/api/v4/contacts

Query parameters

withstring

Este parámetro acepta una cadena que puede consistir en varios valores separados por comas

pageinteger

Página de muestra

limitinteger

El número de entidades retornadas en la respuesta de una solicitud (límite – 250)

querystring json

String o integer. La consulta de búsqueda realizará una búsqueda por los valores de los campos personalizados

order[updated_at]'asc' | 'desc'

Clasificación de elementos de la lista

order[id]'asc' | 'desc'

Clasificación de elementos de la lista

filter[id][]integer[]

Filtrar por ID del contacto

filter[name][]string[]

Filtrar por nombre del contacto

filter[created_by][]integer[]

Filtrar por ID del usuario que añadió el/los contacto(s)

filter[updated_by][]integer[]

Filtrar por ID del usuario que actualizó por última vez el contacto

filter[responsible_user_id][]integer[]

Filtrar por ID del usuario responsable del contacto

filter[created_at][from]integer

Filtrar por la fecha de creación del contacto en formato Unix Timestamp. Como respuesta, obtendrás todos los contactos añadidos después de esa fecha

filter[created_at][from]integer

Filtrar por la fecha de creación del contacto en formato Unix Timestamp. Como respuesta, obtendrás todos los contactos añadidos antes de esa fecha

filter[updated_at][from]integer

Filtrar por la fecha de actualización del contacto en formato de Unix Timestamp. Como respuesta, obtendrás todos los contactos actualizados después de esa fecha

filter[updated_at][to]integer

Filtrar por la fecha de actualización del contacto en formato de Unix Timestamp. Como respuesta, obtendrás todos los contactos actualizados antes de esa fecha

filter[closest_task_at][from]integer

Filtrar contactos por la tarea más cercana a su finalización en formato Unix Timestamp

filter[closest_task_at][to]integer

Filtrar contactos por la tarea más cercana a su finalización en formato Unix Timestamp

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": "Teléfono",
            "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"
                }
              }
            }
          ]
        }
      }
    ]
  }
}