Docuflex › E-signature › API › Account admin

API reference: Account admin

Usage, webhook failures, envelope search and alert settings.

Method	Path	What it does
`GET`	`/v1/accounts/{accountId}/admin/usage`	Usage dashboard: per-day envelope counts, completion rate, timing, top templates, storage, webhook success
`GET`	`/v1/accounts/{accountId}/admin/webhook-failures`	Recent failed/exhausted webhook deliveries
`GET`	`/v1/accounts/{accountId}/admin/envelopes/search`	Search envelopes by subject, recipient email, or envelope id
`PATCH`	`/v1/accounts/{accountId}/admin/alerts`	Configure alert destinations/thresholds
`GET`	`/v1/admin/platform/health-history`	Hourly health-check history + latest status (platform-wide; see multi-tenant caveat)
`POST`	`/v1/admin/platform/health-runs`	Record a health-check run (internal cron only; HMAC-protected)

Conventions

Base URL: https://api.docuflex.net; tenant routes are /v1/accounts/{accountId}/....
Auth: x-api-key: dfx_live_..., or Authorization: Bearer <OAuth2 access token>.
Errors: always {"error":{"code","message","details","requestId"}}; the requestId is also in the x-request-id header.
Pagination: offset (?page=&pageSize=, max 100) or cursor (?cursor=&limit=, follow nextCursor until hasMore is false).
Idempotency: any POST or PUT accepts Idempotency-Key; same key + different body is 409 IDEMPOTENCY_KEY_REUSED.
Rate limits: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset on every response; 429 RATE_LIMITED with Retry-After.
Tabs: coordinates are fractions of the page (origin top-left); documentIndex and recipientIndex refer to positions in the same request.
Spec: /openapi.json (OpenAPI 3). TypeScript client @docuflex/sdk; Postman and Bruno collections ship with the repo.