Template dashboard
One row per readable document of the template across all versions, with the configured summary columns. Filters, sorting and search as in GET…
One row per readable document of the template across all versions, with the configured summary columns. Filters, sorting and search as in GET /documents/search (filters/sort on this template's summary keys).
Authorization
bearerAuth In: header
Path Parameters
Query Parameters
Full-text search over the document text and its summary. Words, prefixes, DNI/NIE and references; case and accents ignored; no typo tolerance. A document matches on any word; documents matching more words rank first.
length <= 400Comma-separated summary states: ready, stale, pending, running, failed, not_extracted, no_schema.
JSON array of {key, op, value} on top-level summary keys of templateId (ops: eq, contains, gt, gte, lt, lte, empty, notEmpty). Requires templateId.
relevance (default with q), updatedAt (default), createdAt, title or summary..
Value in
- "asc"
- "desc"
user (default): documents you own or that are shared with you. admin: every document of the organization (organization admins only).
Value in
- "user"
- "admin"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/templates/string/dashboard"{ "config": { "availableKeys": [ { "key": "string", "label": "string", "type": "string" } ], "canConfigure": true, "columns": [ { "key": "string", "label": "string", "type": "string" } ], "columnsConfigured": true, "draftSummarySchema": { "property1": null, "property2": null }, "templateId": "string", "title": "string", "versions": [ { "id": "string", "summarySchema": { "property1": null, "property2": null }, "version": 0 } ] }, "page": { "items": [ { "apiKeyId": "string", "createdAt": "string", "creatorUserId": "string", "id": "string", "search": { "matchedTerms": 0, "snippets": [ [ { "match": true, "text": "string" } ] ] }, "status": "string", "summary": { "data": { "property1": null, "property2": null }, "error": "string", "extractedAt": "string", "state": "string", "status": "string" }, "templateId": "string", "templateTitle": "string", "templateVersion": 0, "templateVersionId": "string", "title": "string", "updatedAt": "string" } ], "limit": 0, "offset": 0, "total": 0 }}