Skip to content
Qrona Newsletter
Sign inCreate an account

Reference / Lists

Get list

GET/api/v1/lists/{id}

A list with member counts.

Scope

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

Path parameters

idstringrequired
The list's ID.

Response

200 The list.

idstringrequired
namestringrequired
descriptionstring | nullrequired
double_opt_inbooleanrequired
New sign-ups must confirm by email before they are added.
form_enabledbooleanrequired
The list's public sign-up form is open.
countsobjectrequired
Only the contacts that the person behind the key may see.
counts.subscribedintegerrequired
Receive mailings: on the list, active and not suppressed.
counts.pendingintegerrequired
Has signed up but not confirmed yet.
counts.unsubscribedintegerrequired
counts.blockedintegerrequired
On the list but not reachable: they bounce, have made a spam complaint or are suppressed.
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
404
not_found
429
rate_limited
500
internal_error