`list_lists`

Lists the mailing lists of a project, oldest first, at most 100 per call.

Call it: to find a list’s id.
Needs: an admin key with project_id, or a project key with scope read (its own project; the argument is ignored).
Returns: items (lists as get_list returns them) and next_cursor: pass it as cursor for the next page; null on the last page. Deleted lists are left out unless include_deleted is true. The same as GET /api/v1/projects/{project_id}/lists.

Arguments

object
cursorstring | null

next_cursor of the previous page; leave it out for the first.
include_deletedboolean | null

List deleted lists too; default false.
limitinteger · int64 | null

Page size, 1 to 100; default 50.

1–100
project_idstring · uuid | null

The project whose lists to list. An admin key must pass it; a project key’s own project is used and this is ignored.

No other arguments are accepted.

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
itemsarray of List

In creation order.
9 fields
- List object · all fields required
- confirmation_template_idstring · uuid | null
  
  The template of the confirmation letter; null: none.
- created_atstring · date-time
- deleted_atstring · date-time | null
  
  When the list was deleted; null while it is live. A deleted list can only be read.
- double_opt_inboolean
  
  Subscribers confirm by a link before they get campaigns.
- from_overrideFromOverride | null
  
  The sender of the list’s own letters; null: the project’s.
  2 fields
  
  FromOverride object · all fields required
  
  from_emailstring
  
  from_namestring | null
  
  null: the project’s settings.from_name.
- idstring · uuid
- namestring
- project_idstring · uuid
  
  The list’s project.
- updated_atstring · date-time
  
  The latest change: creation, name, options, deletion.
next_cursorstring | null

Pass as cursor for the next page; null on the last page.

The sender of a list’s own letters.

A mailing list of a project (create_list, get_list, update_list; GET /api/v1/projects/{project_id}/lists/{list_id}).

object · all fields required
confirmation_template_idstring · uuid | null

The template of the confirmation letter; null: none.
created_atstring · date-time
deleted_atstring · date-time | null

When the list was deleted; null while it is live. A deleted list can only be read.
double_opt_inboolean

Subscribers confirm by a link before they get campaigns.
from_overrideFromOverride | null

The sender of the list’s own letters; null: the project’s.

see FromOverride
idstring · uuid
namestring
project_idstring · uuid

The list’s project.
updated_atstring · date-time

The latest change: creation, name, options, deletion.

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors