Lista de contactos

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

Limitaciones
El método está disponible de acuerdo con los permisos del usuario.

Parámetros “with”

ParámetroDescripción
leadsAñade información sobre los leads vinculados al contacto en la respuesta.
catalog_elementsAñade los elementos de las listas vinculados al contacto en la respuesta.

Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.

Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.

Parámetros de respuesta

Parámetro

Tipo de dato

Descripción

id

int

ID del contacto.

name

string

Nombre completo del contacto.

first_name

string

Nombre del contacto.

last_name

string

Apellido del contacto.

responsible_user_id

int

ID del contacto responsable.

group_id

int

ID de grupo del usuario responsable del contacto.

created_by

int

ID del usuario que creó el contacto.

updated_by

int

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

created_at

int

Fecha de creación del contacto en formato Unix Timestamp.

updated_at

int

Fecha de actualización del contacto en formato Unix Timestamp.

closest_task_at

int

Fecha de la tarea abierta más cercana en formato Unix Timestamp.

custom_fields_values

array|null

Un arreglo de los valores actuales de los campos personalizados del contacto.

account_id

int

ID de la cuenta en la que se encuentra el contacto.

  • embedded

object

Datos de entidades asociadas.

  • embedded[tags]

array

Arreglo de datos de etiquetas del contacto.

  • embedded[tags][0]

object

Modelo de etiqueta del contacto.

  • embedded[tags][0][id]

int

ID de la etiqueta.

  • embedded[tags][0][name]

string

Nombre de la etiqueta.

  • embedded[tags][0][color]

string/null

Color de la etiqueta.

  • embedded[companies]

array

Modelo de etiqueta de contacto.

  • embedded[companies][0]

object

Datos de la compañía asociada.

  • embedded[companies][0][id]

int

ID de la compañía asociada.

  • embedded[leads]

array

El parámetro GET “with” es obligatorio.
Arreglo de datos de leads asociado.

  • embedded[leads][0]

object

Datos del lead asociados.

  • embedded[leads][0][id]

int

ID del lead asociado.

  • embedded[catalog_elements][catalog_elements]

array

El parámetro GET “with” es obligatorio.
Arreglo de datos de los elementos de las listas asociadas.

  • embedded[catalog_elements][0]

object

Datos del elemento de la lista asociada.

  • embedded[catalog_elements][0][id]

int

ID del elemento asociado.

  • embedded[catalog_elements][0][metadata]

object

Metadatos del elemento.

  • embedded[catalog_elements][0][quantity]

int

Cantidad de elementos asociados.

  • embedded[catalog_elements][0][catalog_id][catalog_id]

int

ID de la lista asociada al elemento.

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!