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}

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/tenants/:tenant_id/get.ts
A function with typed inputs. Its response is checked against the schema.

tenant_idstring required

A unique identifier representing the tenant to be returned.

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.

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