> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/configuration/tenants.md).

# Tenants

Tenant settings, branding, and feature configuration.

## GET /tenants/{tenantId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}":{"get":{"operationId":"TenantsController_find","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns a `Tenant`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"release":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TenantReleaseDto"}]},"settings":{"$ref":"#/components/schemas/CollectionRefDto"},"taxonomies":{"$ref":"#/components/schemas/CollectionRefDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","displayNameShort","release","settings","taxonomies","errors","_links"]},"TenantReleaseDto":{"type":"object","properties":{"version":{"type":"string","readOnly":true}},"required":["version"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}}}
```

## GET /tenants/{tenantId}/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/settings":{"get":{"operationId":"TenantsController_findSettings","parameters":[],"responses":{"200":{"description":"Returns a `TenantSettingCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettingCollectionDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantSettingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","value","errors"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/admin-settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TenantSettingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","value","errors"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/tenants/{tenantId}/admin-settings":{"get":{"operationId":"TenantsController_findAdminSettings","parameters":[],"responses":{"200":{"description":"Returns a `TenantSettingCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettingCollectionDto"}}}}},"tags":["Tenants"]}}}}
```

## GET /tenants/{tenantId}/taxonomies

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies":{"get":{"operationId":"TenantsController_findTaxonomies","parameters":[],"responses":{"200":{"description":"Returns a `TenantTaxonomyCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantTaxonomyDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantTaxonomyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"required":["id","value"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## PATCH /tenants/current

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TenantPatchableDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"}},"required":["displayName","displayNameShort"]},"TenantDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"release":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TenantReleaseDto"}]},"settings":{"$ref":"#/components/schemas/CollectionRefDto"},"taxonomies":{"$ref":"#/components/schemas/CollectionRefDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","displayNameShort","release","settings","taxonomies","errors","_links"]},"TenantReleaseDto":{"type":"object","properties":{"version":{"type":"string","readOnly":true}},"required":["version"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/tenants/current":{"patch":{"operationId":"TenantsController_patchTenant","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantPatchableDto"}}}},"responses":{"200":{"description":"Returns a `Tenant`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantDto"}}}}},"tags":["Tenants"]}}}}
```

## PATCH /tenants/current/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TenantSettingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","value","errors"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/tenants/current/settings":{"patch":{"operationId":"TenantsController_patchCurrentTenantSettings","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettingCollectionDto"}}}},"responses":{"200":{"description":"Returns a `TenantSettingCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantSettingCollectionDto"}}}}},"tags":["Tenants"]}}}}
```

## GET /tenants/current/branches

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/current/branches":{"get":{"operationId":"TenantsController_findBranches","parameters":[],"responses":{"200":{"description":"Returns a `TenantBranchesCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantBranchCollectionDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantBranchCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantBranchDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantBranchDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","pattern":"^s{2}$"},"countryDisplayName":{"type":"string"},"city":{"type":"string"},"description":{"type":"string"},"baseUrl":{"type":"string"},"isDefault":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","countryCode","countryDisplayName","city","description","baseUrl","isDefault","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/current/branches/default

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/current/branches/default":{"get":{"operationId":"TenantsController_findBranchByGeoLocation","parameters":[],"responses":{"200":{"description":"Returns a `TenantBranch`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantBranchDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantBranchDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","pattern":"^s{2}$"},"countryDisplayName":{"type":"string"},"city":{"type":"string"},"description":{"type":"string"},"baseUrl":{"type":"string"},"isDefault":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","countryCode","countryDisplayName","city","description","baseUrl","isDefault","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/current/branches/{branchId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/current/branches/{branchId}":{"get":{"operationId":"TenantsController_findBranchesById","parameters":[{"name":"branchId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `TenantBranch`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantBranchDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"TenantBranchDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","pattern":"^s{2}$"},"countryDisplayName":{"type":"string"},"city":{"type":"string"},"description":{"type":"string"},"baseUrl":{"type":"string"},"isDefault":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","countryCode","countryDisplayName","city","description","baseUrl","isDefault","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## PATCH /tenants/{tenantId}/taxonomies/{taxonomyId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TenantTaxonomyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"required":["id","value"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/tenants/{tenantId}/taxonomies/{taxonomyId}":{"patch":{"operationId":"TenantsTaxonomiesController_patchTaxonomy","parameters":[{"name":"taxonomyId","required":true,"in":"path","description":"Taxonomy Ids like: event-quick-filters, event-types, event-tags, app-menu","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantTaxonomyDto"}}}},"responses":{"200":{"description":"Returns a `TenantTaxonomy`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantTaxonomyDto"}}}}},"tags":["Tenants"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/event-quick-filters

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies/event-quick-filters":{"get":{"operationId":"TenantsTaxonomiesController_findEventsQuickFilters","parameters":[],"responses":{"200":{"description":"Returns a `EventQuickFiltersTaxonomy`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTagsNodeDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"EventTagsNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"color":{"type":"string"},"priority":{"type":"number"},"isListed":{"type":"boolean"}},"required":["id","displayName","value","type","_links","color","priority","isListed"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/event-types

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies/event-types":{"get":{"operationId":"TenantsTaxonomiesController_findEventTypes","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns a `EventTagsTaxonomy`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTagsNodeDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"EventTagsNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"color":{"type":"string"},"priority":{"type":"number"},"isListed":{"type":"boolean"}},"required":["id","displayName","value","type","_links","color","priority","isListed"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/event-types/{nodeId}/template

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies/event-types/{nodeId}/template":{"get":{"operationId":"TenantsTaxonomiesController_findEventTypeTemplate","parameters":[{"name":"nodeId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `EventTagsTaxonomy`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTagsNodeDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"EventTagsNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"color":{"type":"string"},"priority":{"type":"number"},"isListed":{"type":"boolean"}},"required":["id","displayName","value","type","_links","color","priority","isListed"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/event-tags

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies/event-tags":{"get":{"operationId":"TenantsTaxonomiesController_findEventTags","parameters":[],"responses":{"200":{"description":"Returns a `EventTagsTaxonomy`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTagsNodeDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"EventTagsNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"color":{"type":"string"},"priority":{"type":"number"},"isListed":{"type":"boolean"}},"required":["id","displayName","value","type","_links","color","priority","isListed"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/app-menu

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"paths":{"/tenants/{tenantId}/taxonomies/app-menu":{"get":{"operationId":"TenantsTaxonomiesController_findAppMenuNodes","parameters":[],"responses":{"200":{"description":"Returns a `AppMenuNode`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMenuNodeDto"}}}}},"tags":["Tenants"]}}},"components":{"schemas":{"AppMenuNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"isActive":{"type":"boolean","description":"Whether the menu item is active/visible. Defaults to true if not specified."}},"required":["id","displayName","value","type","_links"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}}
```

## GET /tenants/{tenantId}/taxonomies/admin-app-menu

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Tenants","description":"Tenant settings, branding, and feature configuration."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"AdminAppMenuNodeCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAppMenuNodeDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AdminAppMenuNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"priority":{"type":"number"}},"required":["id","displayName","value","type","_links","priority"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/tenants/{tenantId}/taxonomies/admin-app-menu":{"get":{"operationId":"TenantsTaxonomiesController_getAdminAppMenu","parameters":[],"responses":{"200":{"description":"Returns the admin app menu for the current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAppMenuNodeCollectionDto"}}}}},"tags":["Tenants"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/configuration/tenants.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.