Tenants

List tenants

Tenants are your own customers inside one Groundmail account, each with its own domains, suppression list, stats, sending ramp and pause switch. Included on the Scale (up to 1,000 tenants) and Dedicated (up to 10,000) plans; other plans get 403 tenants_not_enabled.

get/tenants

Request

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

Query parameters

status'active' | 'paused'

Only tenants with this status

limitinteger

Maximum number of tenants to return (1–100)

cursorstring

Opaque cursor for the next page

Response

A page of tenants

has_moreboolean required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.