Saltar al contenido
Índice

Buscar contactos

GET/v1/crm/contacts

Por teléfono (E.164), correo o nombre, en la empresa de la llave y lo compartido. Sin ficha con ese teléfono, devuelve los contactos de la cuenta cuyo teléfono general es ese número (matchedBy company_phone).

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 consulta

  • phonestring

    Teléfono en E.164 (se aceptan espacios). Casa con números puestos por una persona, importados o heredados.

    teléfono E.164 · hasta 40 caracteres

  • emailstring

    Correo exacto, sin distinguir mayúsculas.

    correo · hasta 254 caracteres

  • qstring

    Parte del nombre.

    de 2 a 100 caracteres

  • includeStorePhonesstring

    true para casar también con números que escribió un comprador en la tienda (no comprobados).

    uno de: true, false

  • limitinteger

    Cuántos por página.

    de 1 a 50

  • cursorstring

    El nextCursor de la página anterior.

    hasta 2000 caracteres

Respuestas

  • 200Los que casan (puede ser ninguno).Ver campos
    • itemsarray de objectobligatorio

      Contactos.

      hasta 50 elementos

    • items[].idstringobligatorio

      El contacto.

      uuid · hasta 36 caracteres

    • items[].namestringobligatorio

      Nombre completo.

    • items[].jobTitlestring · puede ser nullobligatorio

      Cargo.

    • items[].stagestringobligatorio

      En qué punto está la relación.

    • items[].companyobject · puede ser nullobligatorio

      Su cuenta.

    • items[].company.idstringobligatorio

      La cuenta.

      uuid · hasta 36 caracteres

    • items[].company.namestringobligatorio

      Nombre.

    • items[].ownerobject · puede ser nullobligatorio

      Su responsable.

    • items[].owner.namestringobligatorio

      Nombre.

    • items[].phonesarray de objectobligatorio

      Sus teléfonos.

    • items[].phones[].numberstringobligatorio

      Como se guardó.

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

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

    • items[].phones[].kindstringobligatorio

      work, personal u other.

    • items[].phones[].isPrimarybooleanobligatorio

      El principal.

    • items[].phones[].sourcestringobligatorio

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

    • items[].emailsarray de objectobligatorio

      Sus correos.

    • items[].emails[].addressstringobligatorio

      La dirección.

    • items[].emails[].isPrimarybooleanobligatorio

      El principal.

    • items[].matchedBystringobligatorio

      Con qué casó.

      uno de: phone, company_phone, email, name

    • items[].phoneSourcestring · puede ser nullobligatorio

      Si casó por teléfono, quién puso ese número: es una pista, no una identidad.

    • nextCursorstring · puede ser nullobligatorio

      Para la página siguiente; nulo al final.

  • 400Algo no es válido: error.field dice qué.
  • 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).
  • 429Más de 120 peticiones por minuto. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.