Hoppa till innehållet

Referens / Kontakter

Lista kontakter

GET/api/v1/contacts

Kontakterna som nyckeln får se, i id-ordning, en sida i taget.

Svaret innehåller arbetsytans egna kontakter och de som delas med den från en nivå ovanför (shared: true), begränsat av de kontaktvillkor personen bakom nyckeln har.

Hämta nästa sida med cursor=next_cursor tills has_more är false. För löpande synk: spara tiden innan du börjar och hämta sedan med updated_since.

Behörighet

  • contacts:read Läsa kontakter – personen bakom nyckeln måste vara alla medlemmar.

Query-parametrar

limitinteger
Hur många som högst ska komma i svaret (1–500, standard 100).minst 1 · högst 500 · standard 100
cursorstring
next_cursor från förra svaret, för nästa sida. Utelämna för första sidan.
statusstring
Bara kontakter med den statusen. Utan: alla utom raderade.activeunsubscribedbouncedcomplaineddeleted
list_idstring
Bara kontakter som är med på listan (oavsett medlemskapets status).
segment_idstring
Bara kontakter i distributionslistan.
tagstring
Bara kontakter med taggen (exakt stavning).
updated_sincestring
Bara kontakter som ändrats sedan dess (ISO 8601). Bra för synk: spara tiden för förra hämtningen.
originstring
own: bara arbetsytans egna · shared: bara delade från en nivå ovanför.ownshared

Svar

200 En sida kontakter.

dataarray<object>krävs
data[].idstringkrävs
Kontaktens id.
data[].emailstringkrävs
E-postadressen (gemener). Ändras aldrig: samtycken och spärrar gäller adressen.
data[].first_namestring | nullkrävs
data[].last_namestring | nullkrävs
data[].companystring | nullkrävs
data[].phonestring | nullkrävs
I internationellt format (E.164), t.ex. +46701234567.
data[].statusstringkrävs
active: kan få utskick · unsubscribed: har avregistrerat sig från allt · bounced: adressen studsar · complained: har anmält skräppost · deleted: raderad (GDPR), personuppgifterna är borta.activeunsubscribedbouncedcomplaineddeleted
data[].fieldsobject<string | number | boolean>krävs
Egna fält efter nyckel (se GET /fields). Känsliga fält, som personnummer, skickas aldrig ut.
data[].tagsarray<string>krävs
data[].sourcestringkrävs
Hur kontakten kom in: manual, import, form, api …
data[].consentobjectkrävs
data[].consent.atstring (tid, ISO 8601) | nullkrävs
När samtycket gavs.
data[].consent.sourcestring | nullkrävs
Hur personen samtyckte, med egna ord.
data[].suppressionobject | nullkrävs
Arbetsytans spärr på adressen. En spärrad adress får aldrig utskick, oavsett status.
data[].suppression.reasonstringkrävs
unsubscribed, bounced, complained, manual eller imported.
data[].suppression.created_atstring (tid, ISO 8601)krävs
När adressen spärrades.
data[].sharedbooleankrävs
Delad från en nivå ovanför i organisationen: kan läsas och få utskick härifrån, men bara ändras där den hör hemma.
data[].created_atstring (tid, ISO 8601)krävs
När kontakten skapades.
data[].updated_atstring (tid, ISO 8601)krävs
När kontakten senast ändrades.
data[].unsubscribed_atstring (tid, ISO 8601) | nullkrävs
När personen avregistrerade sig.
has_morebooleankrävs
Det finns fler: hämta nästa sida med cursor=next_cursor.
next_cursorstring | nullkrävs
Skicka som cursor för nästa sida. null på sista sidan.

Fel