Get tenant
GET
Fetch one tenant record.
Self-hosted surface. On managed CloudPDF this is operated by the platform — your account is already a tenant. Start at Tenant documents.
Authentication#
API token
The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.
Parameters#
tenantIdpathstringrequiredSDK 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.tenants.get({
tenantId: "tenantId"
});Responses#
200OK
application/jsonTenantsGet200ResponsetenantobjectidstringnamestringautoProvisionedbooleanstatus"active" | "suspended"optionalcreatedAtnumber404Not found
application/jsonTenantsGet404ResponseerrorobjectcodestringmessagestringdefaultError
application/jsonAdminErrorPayloaderrorobjectcodestringmessagestring