Hoppa till innehållet

Referens / Listmedlemmar

Lista medlemmar

GET/api/v1/lists/{id}/members

Listans medlemmar, en sida i taget.

Behörighet

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

Sökvägsparametrar

idstringkrävs
Listans id.

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
subscribed: får utskick · pending: väntar på bekräftelse · unsubscribed: har lämnat · blocked: med men nås inte.subscribedpendingunsubscribedblocked

Svar

200 En sida medlemmar.

dataarray<object>krävs
data[].contact_idstringkrävs
data[].emailstringkrävs
data[].first_namestring | nullkrävs
data[].last_namestring | nullkrävs
data[].statusstringkrävs
subscribedpendingunsubscribed
data[].contact_statusstringkrävs
activeunsubscribedbouncedcomplaineddeleted
data[].sendablebooleankrävs
Får utskick till listan just nu (med på listan, aktiv och inte spärrad).
data[].subscribed_atstring (tid, ISO 8601) | nullkrävs
När personen kom med.
data[].unsubscribed_atstring (tid, ISO 8601) | nullkrävs
När personen lämnade listan.
data[].created_atstring (tid, ISO 8601)krävs
När medlemskapet skapades.
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