latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Tenant Specialty

List specialties configured for the tenant

Returns the specialties that have been configured for the tenant identified by the tenant-id header.

What it does: Fetches a page of tenant specialty records — each record links a global specialty definition to this tenant and may carry tenant-specific metadata.

When to use: Use this endpoint to display or enumerate specialties active for a tenant. To narrow results to a specific classification taxonomy, use GET /tenant-specialties/by-classification instead.

How to call it: Supply the required tenant-id header. The name query parameter is accepted but is not currently forwarded to the data layer — it has no effect on the returned results (tracked as a known limitation, not fixed by this documentation change). Pagination is not exposed: every call returns a fixed first page of up to 10 records regardless of how many tenant specialties exist for the tenant.

What you get back: A JSON object containing a data array of tenant specialty objects and a totalCount integer reflecting the full count before pagination. Requires the READ_TENANT_SPECIALTY permission.

get/tenant-specialties

Query parameters

namestring

Filter tenant specialties by name. Accepted but not currently applied by the data layer — has no effect on results.

Headers

tenant-idstring required

Tenant identifier that scopes the query.

Response

The (fixed first page of the) tenant's specialties, plus the total count before pagination.

totalCountinteger

Total number of tenant specialty records matching the query, before pagination. Note the underlying list endpoints return at most a single fixed page of results, so this may exceed the number of items in data.