Skip to main content

List tenant-scoped templates with filters

GET 
/templates

Returns a paginated list of roster templates belonging to the requesting tenant.

When to use: Call this to browse available templates before creating a roster upload, or to check the processing status of previously created templates. For a single template's full details use GET /templates/{id}; for the ordered column definitions of a scratch-built template use GET /templates/{id}/columns.

How: Supply the required tenant-id header. Page with page (0-based) and size (defaults to 50 when omitted or non-positive, silently clamped to a maximum of 100). Filter with status (exact, case-sensitive match; the values written by this API are in-progress, success, and failure), type (exact, case-sensitive match: PRACTITIONER, FACILITY, or GROUP), and/or templateName (case-insensitive substring match).

Returns: A paginated envelope whose data items are template records; each record's data object includes the template's name, type, status, and a mappingsUrl - a V4-signed GCS download URL for the column-mappings file, valid for 7 days, generated at request time and never stored. Each record also carries createdByName and createdByEmail, the creator's display name and email resolved in one bounded batch lookup per page (CP-39764); either is null when it could not be resolved, and clients fall back to the raw createdBy id. The envelope's links is always null on this endpoint; totalCount carries the number of matches across all pages. Read-only; no state is changed.

Request​

Responses​

One page of the tenant's templates matching the filters, each with a request-time signed mappingsUrl injected into its data object.