Skip to main content

List egress templates for a tenant

GET 
/api/v1/egress-templates

Returns a page of egress templates scoped to the tenant identified by the required tenant-id header. Use this to browse, filter, or search for a template before fetching a single record with GET /api/v1/egress-templates/{templateId}.

Preconditions: tenant-id header must be present and non-blank; omitting it returns 400.

Filtering: supply status and/or entityType to narrow results; both filters are combined with AND. status accepts active, inactive, or draft; when omitted, only active and draft templates are returned — soft-deleted (inactive) templates are hidden by default and must be requested explicitly via status=inactive. entityType accepts practitioner, facility, or group; when omitted, all entity types are returned. search performs a case-insensitive substring match on templateName. An unrecognised status or entityType value returns 400.

Pagination: page-based. page is the zero-based page number and defaults to 0 when omitted or negative. size is the page size and defaults to 25 when omitted or non-positive; there is no enforced upper bound on size.

Returns: a page of egress template objects for the tenant, plus total, page, size, and hasMore for pagination. Returns an empty templates array (not 404) when no templates match. This operation is read-only with no side effects.

Request​

Responses​

A page of egress templates matching the tenant, filters, and search term, with pagination metadata