List paginated documents
List paginated documents. See the OpenAPI-defined parameters, request body, and responses below.
GET
/Document/pagedList paginated documents. See the OpenAPI-defined parameters, request body, and responses below.
OpenAPI description: Este endpoint retorna documentos paginados conforme o filtro informado.
Authentication
Authentication required. Send your user API key in the X-API-Key header.
Parameters
| Name | Location | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
Title | query | string | No | — | — |
CreatedAtStart | query | string · date-time | No | — | — |
CreatedAtEnd | query | string · date-time | No | — | — |
TenantId | query | integer · int32 | No | — | — |
Page | query | integer · int32 | No | — | — |
PageSize | query | integer · int32 | No | — | — |
Private | query | boolean | No | — | — |
CreatedByUserId | query | integer · int32 | No | — | — |
Request body
This operation does not accept a request body.
Example request
curl --request GET \
--url 'https://api.zild.ai/Document/paged?Title={Title}&CreatedAtStart={CreatedAtStart}&CreatedAtEnd={CreatedAtEnd}&TenantId={TenantId}&Page={Page}&PageSize={PageSize}&Private={Private}&CreatedByUserId={CreatedByUserId}' \
--header 'X-API-Key: YOUR_USER_API_KEY'
Responses
| Status | Description | Response body |
|---|---|---|
200 | OK | application/json · DocumentCreateResponseDtoPagedResultDto |
Example response (200):
{
"items": [
{
"id": 0,
"title": "string",
"description": "string",
"extractedText": "string",
"analysisText": "string",
"fileUrl": "string",
"documentStatusId": 0,
"documentType": 0,
"createdAt": "2026-09-22T18:00:00Z",
"analizedAt": "2026-09-22T18:00:00Z",
"documentChecklistId": 0,
"private": true
}
],
"totalCount": 0
}
Data models
DocumentCreateResponseDto
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
id | integer · int32 | No | — | — |
title | string | No | — | nullable |
description | string | No | — | nullable |
extractedText | string | No | — | nullable |
analysisText | string | No | — | nullable |
fileUrl | string | No | — | nullable |
documentStatusId | integer · int32 | No | — | — |
documentType | DocumentType | No | — | — |
createdAt | string · date-time | No | — | nullable |
analizedAt | string · date-time | No | — | nullable |
documentChecklistId | integer · int32 | No | — | — |
private | boolean | No | — | — |
DocumentCreateResponseDtoPagedResultDto
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
items | array<DocumentCreateResponseDto> | No | — | nullable |
totalCount | integer · int32 | No | — | — |
DocumentType
0 = Image; 1 = Word; 2 = PDF; 3 = Text
integer