563848e0ecc0
List tenant-scoped templates with filters
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. 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.
Query parameters
0-based page number for offset pagination. Omitted or negative values are treated as the first page.
Records per page. Defaults to 50 when omitted or non-positive; values above 100 are silently clamped to 100.
Only return templates with this processing status. Exact, case-sensitive match; values written by this API are in-progress, success, and failure. Omit to include all statuses.
Only return templates whose name contains this text (case-insensitive substring match). Omit to include all names.
Only return templates of this roster type. Exact, case-sensitive match against PRACTITIONER, FACILITY, or GROUP. Omit to include all types.
Headers
Tenant whose templates are listed; results never include other tenants' templates.
Response
One page of the tenant's templates matching the filters, each with a request-time signed mappingsUrl injected into its data object.
Example response
{
"data": [
{
"id": "3f8e2b6c-9d41-4a7b-b6a0-5e2f8c1d9a37",
"tenantId": "tenant_001",
"createdAt": "2022-03-10T16:15:50Z",
"createdBy": "auth0|64f1c2d3e4b5a6",
"updatedAt": "2022-03-10T16:15:50Z",
"updatedBy": "auth0|64f1c2d3e4b5a6"
}
],
"totalCount": 12
}