Leads

Leads in een lijst

gethttps://aicquisitioncrm.nl/api/v2/lijsten/{id}/leads

Recht: lezen.

Nieuwste wijziging eerst. Met gewijzigd_sinds haal je alleen op wat er sinds je vorige keer veranderde: bewaar het gewijzigd van de eerste lead en geef het de volgende keer mee.

Verzoek

In het pad

  • idstring · uuidverplicht

    Het id van de lijst.

In de vraag

  • campagne_idstring · uuid

    Alleen deze campagne.

  • fasestring

    Eén of meer fases, met komma's: gebeld_1,gebeld_2. Zie GET /api/v2/fases.

  • gewijzigd_sindsstring · date-time

    Alleen leads die sinds dit moment veranderden.

  • zoekstring

    Naam, e-mail of telefoonnummer (06… mag); elk woord moet ergens voorkomen.

  • externe_idstring

    De id die jullie zelf meegaven bij het aanleveren.

  • limietintegerstandaard 50

    Hoeveel per bladzijde, 1 tot 200.

  • cursorstring

    De volgende_cursor uit het vorige antwoord.

Antwoord

200Een bladzijde leads.

  • datalijst van objecten
    Velden tonen
    • idstring · uuid
    • campagne_idstring · uuid
    • lijst_idstring · uuid of null
    • fasestring

      Een van: nieuwe_leads, gebeld_1, gebeld_2, gebeld_3, gebeld_4, niet_bereikt, follow_up, binnengekomen, pre_call, bevestigd, dag_van_de_call, gewonnen, follow_up_kort, follow_up_lang, verloren, cancel, no_show, reschedule

    • fase_naamstring

      Zoals hij in Aicquisition heet.

    • warmtestring of null

      Een van: koud, warm, heet

    • contactobject
      Velden tonen
      • voornaamstring of null
      • achternaamstring of null
      • telefoonstring of null

        Met landnummer.

      • emailstring of null
      • functiestring of null
    • bedrijfobject of null
      Velden tonen
      • naamstring
      • plaatsstring of null
    • setterobject of null
      Velden tonen
      • naamstring of null
      • emailstring of null
    • closerobject of null
      Velden tonen
      • naamstring of null
      • emailstring of null
    • pogingeninteger

      Hoe vaak er gebeld is.

    • laatste_pogingstring · date-time of null
    • volgende_actiestring · date-time of null

      Wanneer de lead weer aan de beurt is.

    • volgende_actie_is_afspraakboolean

      Is dat moment met de lead afgesproken?

    • waarde_centinteger of null

      Exclusief btw.

    • verloren_redenstring of null
    • upsellboolean
    • wacht_op_akkoordboolean

      Wacht op akkoord voor een hoger beltarief.

    • bronstring of null
    • externe_idstring of null
    • aangemaaktstring · date-time
    • gewijzigdstring · date-time
  • volgende_cursorstring of null

    Geef mee als cursor voor de volgende bladzijde; null betekent klaar.

Foutmeldingen

  • 400Het verzoek klopt niet; het antwoord noemt de fout en het veld.
  • 401Geen sleutel, of een sleutel die niet (meer) werkt.
  • 403De sleutel mist het recht Lezen.
  • 429Meer dan 60 verzoeken per minuut; wacht een minuut.