List lists

Scope

• lists:read Read lists – the person behind the key must be all members.

Response

200 All lists.

dataarray<object>required

data[].idstringrequired

data[].namestringrequired

data[].descriptionstring | nullrequired

data[].double_opt_inbooleanrequired

New sign-ups must confirm by email before they are added.

data[].form_enabledbooleanrequired

The list's public sign-up form is open.

data[].countsobjectrequired

Only the contacts that the person behind the key may see.

data[].counts.subscribedintegerrequired

Receive mailings: on the list, active and not suppressed.

data[].counts.pendingintegerrequired

Has signed up but not confirmed yet.

data[].counts.unsubscribedintegerrequired

data[].counts.blockedintegerrequired

On the list but not reachable: they bounce, have made a spam complaint or are suppressed.

data[].created_atstring (time, ISO 8601)required

When the list was created.

Errors

401

unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive

402

payment_required

403

insufficient_scopeforbiddenworkspace_suspended

429

rate_limited

500

internal_error