v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Tenants

Get a Tenant

Returns one tenant with its name, parent tenant id, default preferences, properties, and the user profile applied to its members.

get/tenants/{tenant_id}

Path parameters

tenant_idstring required

A unique identifier representing the tenant to be returned.

Response

idstring required

Id of the tenant.

namestring required

Name of the tenant.

parent_tenant_idstring nullable

Tenant's parent id (if any).

propertiesobject nullable

Arbitrary properties accessible to a template.

user_profileobject nullable

A user profile object merged with user profile on send.

brand_idstring nullable

Brand to be used for the account when one is not specified by the send call.