NAnace
tenants

get_tenant

Read one tenant. Cost class: cacheable.

get/v1/tenants/{external_ref}

Request

Path parameters

external_refstring required

The partner's own reference for the tenant, such as its account id.

Response

Successful Response

idstring uuid required

NDI's id for the tenant; X-NDI-Tenant accepts it too.

external_refstring required

The partner's own reference for the tenant, unique per partner.

display_namestring nullable required

Human-readable name of the tenant.

disabledboolean required

Whether the tenant is disabled. Its data is kept.

data_retention'short' | 'zero_retention' required

Retention for document operations — a client setting, not a request field.

A data-handling guarantee a caller can accidentally opt out of on one endpoint is not a guarantee, so this is configured per client at onboarding and appears in no request body.

created_atstring date-time required

When the tenant was created.

Changes

No recorded changes to this operation across all 1 revision of this API.