latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Tenant Configuration

List all configuration entries for a tenant

Returns every stored configuration record for the tenant identified by the required tenant-id header. The response is a TenantConfigurationListResponseDto envelope containing a data array of TenantConfigurationItemDto objects and a totalCount field.

Use this endpoint when you need all configuration types at once. To retrieve a single type, use GET /tenant-configurations/by-configuration-type/{configurationTypeId} instead; that sibling path serves results from a server-side cache, whereas this endpoint does not read from or populate that cache.

This endpoint returns only persisted records. Unlike the by-type endpoint, it does not synthesize a default tenant-timezone-config (America/New_York) when none is stored, so tenants without a persisted timezone record will not have one in the returned list.

Preconditions: the tenant-id header must be present; omitting it returns 400.

This is a read-only operation with no side effects.

get/tenant-configurations

Headers

tenant-idstring required

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

Response

Envelope containing every stored configuration record for the tenant and the total count.

totalCountinteger

Total number of tenant configurations

Example response

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