Suppressions

List suppressions or category opt-outs

Changed on
get/suppressions

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/suppressions
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring
emailstring email

Filter by normalized email address

tenantstring

List this tenant's own suppression list (its external_id or id) instead of the account-wide list. A key limited to one tenant always sees its tenant's list.

type'suppression' | 'category_opt_out'

category_opt_out works on category opt-outs (a reader's one-click unsubscribe from product or newsletter email) instead of the suppression list.

category'product' | 'newsletter'

With type=category_opt_out, only opt-outs from this category.

include_tenantsboolean

With type=category_opt_out and no tenant, also list every tenant's opt-outs (each entry names its tenant). Ignored for a key limited to one tenant.

Response

Suppression list, or category opt-outs with type=category_opt_out (ListCategoryOptOutsResponse).

OR

Changes

  • 479821c9fecfRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter include_tenants

    • info

      added the new optional query request parameter type

    • info

      added the non-success response with the status