Saltar al contenido
Índice

Resumen del contacto

GET/api/v1/crm/contacts/{id}/context

La ficha, sus oportunidades abiertas, las cinco últimas interacciones y sus tareas abiertas. Fuera del alcance de la llave, 404.

Permiso de la llave:crm.read

Cabeceras

  • Authorizationstringobligatorio

    Bearer y el secreto de la llave.

Parámetros de ruta

  • idstringobligatorio

    El contacto.

    uuid

Respuestas

  • 200El contexto.Ver campos
    • contactobjectobligatorio

      La ficha.

    • contact.idstringobligatorio

      El contacto.

      uuid · hasta 36 caracteres

    • contact.namestringobligatorio

      Nombre completo.

    • contact.jobTitlestring · puede ser nullobligatorio

      Cargo.

    • contact.stagestringobligatorio

      En qué punto está la relación.

    • contact.companyobject · puede ser nullobligatorio

      Su cuenta.

    • contact.company.idstringobligatorio

      La cuenta.

      uuid · hasta 36 caracteres

    • contact.company.namestringobligatorio

      Nombre.

    • contact.ownerobject · puede ser nullobligatorio

      Su responsable.

    • contact.owner.namestringobligatorio

      Nombre.

    • contact.phonesarray de objectobligatorio

      Sus teléfonos.

    • contact.phones[].numberstringobligatorio

      Como se guardó.

    • contact.phones[].e164string · puede ser nullobligatorio

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

    • contact.phones[].kindstringobligatorio

      work, personal u other.

    • contact.phones[].isPrimarybooleanobligatorio

      El principal.

    • contact.phones[].sourcestringobligatorio

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

    • contact.emailsarray de objectobligatorio

      Sus correos.

    • contact.emails[].addressstringobligatorio

      La dirección.

    • contact.emails[].isPrimarybooleanobligatorio

      El principal.

    • contact.languagestring · puede ser nullobligatorio

      Idioma.

    • contact.timeZonestring · puede ser nullobligatorio

      Zona horaria.

    • contact.customFieldsarray de objectobligatorio

      Los campos del cliente con valor.

    • contact.customFields[].keystringobligatorio

      Clave.

    • contact.customFields[].labelstringobligatorio

      Nombre.

    • openOpportunitiesarray de objectobligatorio

      Las 20 más recientes.

      hasta 20 elementos

    • openOpportunities[].idstringobligatorio

      La oportunidad.

      uuid · hasta 36 caracteres

    • openOpportunities[].titlestringobligatorio

      Título.

    • openOpportunities[].stagestring · puede ser nullobligatorio

      Fase.

    • openOpportunities[].amountnumber · puede ser nullobligatorio

      Importe, en la moneda de la organización.

    • openOpportunities[].ownerobject · puede ser nullobligatorio

      Responsable.

    • openOpportunities[].owner.namestringobligatorio

      Nombre.

    • openOpportunitiesTotalintegerobligatorio

      Cuántas hay en total.

      de 0 a 1000000000

    • recentInteractionsarray de objectobligatorio

      Las 5 últimas llamadas, reuniones y visitas registradas (el correo no va).

      hasta 5 elementos

    • recentInteractions[].kindstringobligatorio

      call, meeting o visit.

    • recentInteractions[].atstringobligatorio

      Cuándo.

    • recentInteractions[].summarystringobligatorio

      Resumen.

    • recentInteractions[].typestring · puede ser nullobligatorio

      Tipo.

    • recentInteractions[].durationMinutesinteger · puede ser nullobligatorio

      Minutos.

      de 1 a 32767

    • recentInteractions[].authorobject · puede ser nullobligatorio

      Quién la registró.

    • recentInteractions[].author.kindstringobligatorio

      Una persona o una llave.

      uno de: person, integration

    • recentInteractions[].author.namestringobligatorio

      Nombre.

    • openTasksarray de objectobligatorio

      Las 20 más urgentes.

      hasta 20 elementos

    • openTasks[].idstringobligatorio

      La tarea.

      uuid · hasta 36 caracteres

    • openTasks[].titlestringobligatorio

      Título.

    • openTasks[].dueOnstring · puede ser nullobligatorio

      Para cuándo.

    • openTasks[].assigneeobject · puede ser nullobligatorio

      Quién la tiene.

    • openTasks[].assignee.namestringobligatorio

      Nombre.

    • openTasksTotalintegerobligatorio

      Cuántas hay en total.

      de 0 a 1000000000

  • 401Sin llave, o no vale.
  • 403Fuera del plan (code plan) o sin permiso (code forbidden).
  • 404No existe o no lo alcanza.
  • 429Más de 120 peticiones por minuto. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.