Skip to main content
GET
List files

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

ids
string<uuid>[]

Optional file IDs to include.

status
string

Public status key filter (for example ready).

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

Response

200 - application/json

OK

id
string<uuid>
queueId
string<uuid>
batchId
string<uuid> | null
originalFileName
string | null
contentType
string | null
sizeBytes
integer
publicStatusKey
string | null
internalStageKey
string | null
createdAt
string<date-time>
completedAt
string<date-time> | null
documentCount
integer
reprocessOfFileId
string<uuid> | null
downloadUrl
string | null
downloadUrlExpiresAt
string<date-time> | null
documents
object[] | null