Saltar al contenido
Índice

El contacto

GET/v1/crm/contacts/{id}

La ficha, con su ETag. Con If-None-Match igual al ETag, 304 sin cuerpo. Fuera del alcance de la llave, 404.

Permiso de la llave:«Ver contactos» (contacts_read)Permiso del rol:crm.read

Cabeceras

  • Authorizationstringobligatorio

    Bearer y el secreto de la llave.

Parámetros de ruta

  • idstringobligatorio

    El contacto.

    uuid

Respuestas

  • 200El contacto. Lleva la cabecera ETag.Ver campos
    • idstringobligatorio

      El contacto.

      uuid · hasta 36 caracteres

    • firstNamestringobligatorio

      Nombre.

    • lastNamestring · puede ser nullobligatorio

      Primer apellido.

    • secondLastNamestring · puede ser nullobligatorio

      Segundo apellido.

    • namestringobligatorio

      Nombre completo, como se muestra.

    • jobTitlestring · puede ser nullobligatorio

      Cargo.

    • departmentstring · puede ser nullobligatorio

      Departamento, del vocabulario del cliente.

    • stagestringobligatorio

      En qué punto está la relación: lead, active, inactive o discarded. Pueden aparecer valores nuevos.

    • languagestring · puede ser nullobligatorio

      Idioma, BCP 47.

    • timeZonestring · puede ser nullobligatorio

      Zona horaria IANA.

    • accountobject · puede ser nullobligatorio

      Su cuenta (empresa cliente).

    • account.idstringobligatorio

      La cuenta.

      uuid · hasta 36 caracteres

    • account.namestringobligatorio

      Nombre.

    • ownerobject · puede ser nullobligatorio

      Su responsable, sin correo: es un empleado.

    • owner.idstringobligatorio

      La persona.

      uuid · hasta 36 caracteres

    • owner.namestringobligatorio

      Nombre.

    • phonesarray de objectobligatorio

      Sus teléfonos, el principal primero.

    • phones[].numberstringobligatorio

      Como se guardó.

    • phones[].e164string · puede ser nullobligatorio

      En E.164; nulo si no se pudo calcular.

    • phones[].kindstringobligatorio

      work, personal u other.

    • phones[].isPrimarybooleanobligatorio

      El principal.

    • phones[].sourcestringobligatorio

      Quién lo puso: person, connector (la tienda), import, api o legacy.

    • emailsarray de objectobligatorio

      Sus correos, el principal primero.

    • emails[].addressstringobligatorio

      La dirección.

    • emails[].isPrimarybooleanobligatorio

      El principal.

    • externalIdstring · puede ser nullobligatorio

      El id en el sistema del integrador.

    • sourcestring · puede ser nullobligatorio

      De dónde vino, del vocabulario del cliente.

    • createdAtstringobligatorio

      Alta, RFC 3339 en UTC.

    • updatedAtstringobligatorio

      Último cambio de la ficha, RFC 3339 en UTC.

  • 304No ha cambiado desde ese ETag. Sin cuerpo.
  • 401Sin llave, o no vale.
  • 403Fuera del plan (code plan); la llave sin el permiso de su rol o sin el permiso de API de la operación (code forbidden); o desde una IP que la llave no permite (code ip_not_allowed).
  • 404No existe o no lo alcanza.
  • 429Más de 120 peticiones por minuto con la llave, o de 600 en la organización. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.