Sign in
Tenant Configuration

Retrieve a tenant's configuration for a specific type

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.

get/tenant-configurations/by-configuration-type/{configurationTypeId}

Path parameters

configurationTypeIdstring required

Identifier of the configuration type to retrieve. tenant-timezone-config is the type known to be supported and returns a synthesized America/New_York default when nothing is persisted; any other value returns 404 when no record exists. Required; no default is applied.

Headers

tenant-idstring required

Identifier of the tenant whose configuration is returned. Required; the request is rejected with 400 when it is missing or blank. No default is applied.

Response

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.

idstring

Unique identifier for the configuration

tenantIdstring

Tenant ID this configuration belongs to

namespacestring

Namespace for the configuration

configurationTypeIdstring

Type identifier for the configuration

{"stackTrail":"components:schemas:TenantConfigurationItemDto:properties:configuration","oasType":"schema","type":"unknown","description":"Configuration data as JSON. The structure is flexible and depends on `configurationTypeId`."}
updatedAtstring date-time
createdAtstring date-time

Example response

{
  "updatedAt": "2022-03-10T16:15:50Z",
  "createdAt": "2022-03-10T16:15:50Z"
}

Changes