Skip to main content
GET
List documents

Authorizations

X-Api-Key
string
header
required

API key from the Documate app (Settings → API keys). You may also send Authorization: ApiKey YOUR_API_KEY.

Path Parameters

queueId
string<uuid>
required

Query Parameters

fileId
string<uuid>
batchId
string<uuid>
status
string
createdFrom
string<date-time>
createdTo
string<date-time>

Response

200 - application/json

OK

id
string<uuid>
queueId
string<uuid>
fileId
string<uuid>
batchId
string<uuid> | null
documentTypeId
integer | null
documentTypeKey
string | null
agentId
string<uuid> | null
publicStatusKey
string | null
internalStageKey
string | null
errorCode
string | null
errorMessage
string | null
resultJson
unknown
webhookStatusKey
string | null
webhookAttempts
integer
webhookLastHttpStatus
integer | null
createdAt
string<date-time>
completedAt
string<date-time> | null
downloadUrl
string | null
downloadUrlExpiresAt
string<date-time> | null