List a project's lists

The project’s lists in creation order, a page at a time; deleted ones only with include_deleted=true. Needs scope read; an admin key may list any project’s.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`limit`	query	integer · int64 1–500	Page size, 1 to 500; default 50
`cursor`	query	string	`next_cursor` of the previous page
`include_deleted`	query	boolean	Deleted lists too; default `false`

Request body

None.

Responses

200

One page

ListList 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 · email
  
  from_namestring | null
  
  null: the project’s settings.from_name.
- idstring · uuid
  
  example 01900000-0000-7000-8000-000000000001
- namestring
  
  example Weekly news
- 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.

401

No valid key

Problem (application/problem+json)

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such project, or another project’s (not_found)

Problem (application/problem+json)

422

A parameter is invalid (validation_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)