List documents

GET/v1/tenants/{tenantId}/documentsv3.0.0-next.9

List documents in the tenant, newest first, cursor-paginated.

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Tenant token

Delegated tenant JWT, valid only under its own /v1/tenants/{tenantId}/ subtree — the path tenant must equal the token's tenant_id. Doc-scoped viewer tokens are rejected on every admin route.

Required scopedocs.read

Parameters#

tenantIdpathstringrequired

limitqueryintegerdefault 100

cursorquerystring

statequery"pending" | "ready" | "failed" | "deleting"

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.documents.list({
  tenantId: "tenantId"
});

Responses#

200OK

application/jsonDocumentsList200Response

documentsobject[]

idstring

tenantIdstring

state"pending" | "ready" | "failed" | "deleting"

baseShastring

storageSizeBytesnumber

metadataobject

idempotencyKeystring

failureReasonstring

thumbnailState"pending" | "ready" | "locked" | "failed"optional

thumbnailUrlstringoptional

createdAtnumber

updatedAtnumber

createdBystring

nextCursorstringoptional

400Bad request

application/jsonDocumentsList400Response

errorobject

codestring

messagestring

defaultError

application/jsonAdminErrorPayload

errorobject

codestring

messagestring