List shares

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

List share grants 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 scopeshares.manage

Parameters#

tenantIdpathstringrequired

limitqueryintegerdefault 100

cursorquerystring

docIdquerystring

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.shares.list({
  tenantId: "tenantId"
});

Responses#

200OK

application/jsonSharesList200Response

sharesobject[]

idstring

tenantIdstring

docIdstring

layerNamestring

scopestring[]

originsstring[]

passwordProtectedboolean

sessionTtlSecondsnumber

disabledboolean

expiresAtnumber

exchangeCountnumber

lastExchangedAtnumber

createdBystring

createdAtnumber

updatedAtnumber

nextCursorstringoptional

400Bad request

application/jsonSharesList400Response

errorobject

codestring

messagestring

defaultError

application/jsonAdminErrorPayload

errorobject

codestring

messagestring