Get a Tenant

GET

Path parameters

tenant_idstringRequired

A unique identifier representing the tenant to be returned.

Response

This endpoint returns an object.
idstring

Id of the tenant.

namestring

Name of the tenant.

parent_tenant_idstringOptional

Tenant’s parent id (if any).

default_preferencesobjectOptional

Defines the preferences used for the account when the user hasn’t specified their own.

propertiesmap from strings to anyOptional

Arbitrary properties accessible to a template.

user_profilemap from strings to anyOptional

A user profile object merged with user profile on send.

brand_idstringOptional

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