Postwind Pre-release Download
Docs menu get_list

Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Lists HTTP API

GET/api/v1/projects/{project_id}/lists/{list_id}

get_list

Reads one mailing list: its name, double opt-in, confirmation template and sender.

Call it
to check a list before adding subscribers or sending to it, or whether it is deleted.
Needs
the list’s id and an admin key with project_id, or a project key with scope read (its own project; the argument is ignored; another project’s list is not_found).
Returns
the list (deleted_at is set once it is deleted), the same as GET /api/v1/projects/{project_id}/lists/{list_id}.

Arguments

  • object
  • list_idstring · uuidrequired

    The list’s id, as create_list or list_lists gave it.

  • project_idstring · uuid | null

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

No other arguments are accepted.

Result

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

  • 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.

Definitions

FromOverride

The sender of a list’s own letters.

  • object · all fields required
  • from_emailstring
  • from_namestring | null

    null: the project’s settings.from_name.

Errors

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

HTTP API

The same operation over HTTP: GET /api/v1/projects/{project_id}/lists/{list_id}