Skip to main content

Retrieve a tenant's configuration for a specific type

GET 
/tenant-configurations/by-configuration-type/:configurationTypeId

Returns the stored configuration record for the given configurationTypeId and the tenant identified by the required tenant-id header.

Special behavior for tenant-timezone-config: if no record has been persisted for this tenant, the endpoint synthesizes and returns a default record using timezone America/New_York. In this synthetic default case the id, namespace, updatedAt, and createdAt fields of the returned TenantConfigurationItemDto are null.

The response is a TenantConfigurationItemDto. This shape differs from the flat TenantTimezoneResponse returned by the POST endpoint on the same path.

Use this endpoint to read a single configuration type. To read all types in one call, use GET /tenant-configurations. Results from this path are served from a server-side cache keyed by tenant and configuration type, so a write via the POST endpoint may not be immediately visible here.

Preconditions: the tenant-id header must be present; omitting it returns 400. Supplying a configurationTypeId for which no record exists (and which is not tenant-timezone-config) returns 404.

Request​

Responses​

The stored configuration record for the requested type, or — for tenant-timezone-config with nothing persisted — a synthesized default record with null id/namespace/timestamps.