Docs

Contact support Log in Get started

Overview

Client libraries

API keys

Trigger data filtering

Process a Census RPC request

Process a Hightouch RPC request

Create schedules in bulk

Schedule

ScheduleRepeatRule

Overview

Bulk update message statuses for channel

Get started Log in Contact support

List tenants

List tenants for the current environment.

List tenants

List tenants for the current environment.

Endpoint

GET/v1/tenants

Rate limit

Tier 4

Query parameters

tenant_id

string

Filter tenants by ID.

name

string

Filter tenants by name.

after

string

The cursor to fetch entries after.

before

string

The cursor to fetch entries before.

page_size

integer

The number of items per page (defaults to 50).

Returns

ListTenantsResponse

A response containing a list of tenants.

entries

Tenant[]

A list of tenants.

__typename

string

Required

The typename of the schema.

string

Required

The unique identifier for the tenant.

name

string

An optional name for the tenant.

settings

object

The settings for the tenant. Includes branding and preference set.

branding

object

The branding for the tenant.

icon_url

string(uri)

The icon URL for the tenant. Must point to a valid image with an image MIME type.

logo_url

string(uri)

The logo URL for the tenant. Must point to a valid image with an image MIME type.

primary_color

string

The primary color for the tenant, provided as a hex value.

primary_color_contrast

string

The primary color contrast for the tenant, provided as a hex value.

preference_set

PreferenceSet

The preference set for the tenant. Used to override the default preference set.

page_info

PageInfo

Pagination information for a list of resources.

__typename

string

The typename of the schema.

after

string

The cursor to fetch entries after.

before

string

The cursor to fetch entries before.

page_size

integer

The number of items per page (defaults to 50).