list_projects

Arguments

• object
• cursorstring | null

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

• include_deletedboolean | null

  List deleted projects too; default false.

• limitinteger · int64 | null

  Page size, 1 to 100; default 50.

  1–100

No other arguments are accepted.

Result

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

• object · all fields required
• itemsarray of Project

  In creation order.

  7 fields

  • Project object · all fields required
  • created_atstring · date-time
  • deleted_atstring · date-time | null

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

  • idstring · uuid
  • namestring
  • settingsProjectSettings

    A project’s settings, every field present.

    11 fields

    • ProjectSettings object · all fields required
    • auto_footerboolean

      Add an unsubscribe footer when a template has none.

    • brandingBranding

      How the public pages look.

      4 fields

      • Branding object · all fields required
      • brand_namestring | null
      • languagePageLanguage

        The language of the public pages.

        • en
        • ru
      • support_emailstring | null
      • text_overridesmap of string → string

        Texts of the pages by key.

    • daily_send_quotainteger · uint32 | null

      Most messages a day; null: no quota.

      ≥ 0

    • default_throttle_per_hourinteger · uint32 | null

      Default campaign speed, messages an hour; null: no limit.

      ≥ 0

    • dns_credentialsDnsCredentials

      Which DNS providers the project set its own credentials for; the credentials themselves are never returned.

      1 fields

      • DnsCredentials object · all fields required
      • porkbunboolean

        Whether the project set its own Porkbun credentials.

    • from_emailstring | null

      Default sender address of campaigns.

    • from_namestring | null

      Default sender name of campaigns.

    • reply_tostring | null

      Default Reply-To.

    • soft_bounce_suppress_afterinteger · uint32 | null

      Soft bounces in a row after which an address is suppressed; null: off.

      ≥ 0

    • trackingTracking

      What campaigns track by default.

      2 fields

      • Tracking object · all fields required
      • clicksboolean
      • opensboolean
    • transportstring | null

      Default transport, direct or relay:<name>; null: the node’s default.

  • slugstring

    Unique among live projects; it never changes.

  • updated_atstring · date-time

    The latest change: creation, rename, settings, deletion.

• next_cursorstring | null

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

Definitions

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