API Documentation

Base URL: https://nukeapi.dev · Get your API key →

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer nk_live_your_key_here

Create and manage API keys from your dashboard. Keys are shown once at creation — store them securely.

Quick Start

Get your first deletion working in under 5 minutes:

curl -X POST https://nukeapi.dev/api/v1/delete-user \
  -H "Authorization: Bearer nk_live_••••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "subject_email": "user@example.com",
    "integrations": ["mailchimp", "hubspot", "intercom"]
  }'

Endpoints

POST/api/v1/delete-user

Delete a user from all connected integrations. Returns JSON or a signed PDF audit report.

Auth: Bearer API Key

REQUEST BODY

{
  "subject_email": "user@example.com",  // required — the user to delete
  "integrations": ["stripe",            // optional — defaults to all allowed + enabled
                   "mailchimp",
                   "hubspot"],
  "subject_external_id": "user_123",    // optional — your internal user ID
  "webhook": "https://..."              // optional — signed POST on completion
}

RESPONSE

{
  "success": true,
  "requestId": "req_xxxxxxxx",
  "data": {
    "requestId": "req_xxxxxxxx",
    "status": "completed",          // "completed" | "partial" | "failed"
    "results": [
      { "integration": "stripe",    "status": "success", "message": "Deleted 1 customer(s)", "durationMs": 312 },
      { "integration": "mailchimp", "status": "success", "message": "Removed from 3 list(s)", "durationMs": 187 }
    ],
    "startedAt": "2026-07-01T10:00:00Z",
    "completedAt": "2026-07-01T10:00:01Z",
    "elapsedMs": 890,
    "auditSignature": "hex-hmac-sha256...",
    "usage": {
      "plan": "startup",
      "used": 14,
      "limit": 200,
      "remaining": 186,
      "overageRate": 0.5
    }
  }
}

ERROR CODES

Code	Meaning
`401`	Missing or invalid API key
`403`	INTEGRATION_NOT_ALLOWED — plan does not include the requested integration, or CONNECTOR_DISABLED — toggled off by the owner
`400`	Validation error — invalid email or malformed request body
`402`	QUOTA_EXCEEDED — monthly plan limit reached
`429`	Rate limit (60 req/min per key) exceeded
`500`	Deletion engine error — check results array for per-integration detail

GET/api/v1/status/:requestId

Fetch the result of a previous deletion request by ID.

Auth: Bearer API Key

RESPONSE

{
  "success": true,
  "data": {
    "id": "req_xxxxxxxx",
    "status": "completed",
    "subject_email": "user@example.com",
    "integrations_requested": ["stripe", "mailchimp"],
    "integrations_completed": ["stripe", "mailchimp"],
    "integrations_failed": [],
    "created_at": "2026-07-01T10:00:00Z",
    "completed_at": "2026-07-01T10:00:01Z"
  }
}

ERROR CODES

Code	Meaning
`404`	Request ID not found

Rate Limits

Plan	Requests/min	Deletions/month	Overage
Sandbox	60	20	None
Startup	60	200	$0.50 / deletion
Business	60	1,000	$0.35 / deletion
Enterprise	Custom	Unlimited	Included

Available Integrations

Availability is controlled by the account owner. Every connector below is toggleable on/off from the owner dashboard — a disabled or hidden connector cannot be connected or run, and any request targeting it returns a 403 CONNECTOR_DISABLED. Only connectors the owner has released are listed here; newly-built connectors stay hidden until released.

Key	Service	What gets deleted

Partial Failures

Each integration runs independently. If one fails, the others still complete. The response status field reflects the aggregate outcome:

completed — all requested integrations succeeded
partial — some succeeded, some failed
failed — all integrations failed

Usage is only incremented on completed and partial — not on full failures.

PDF Audit Reports

Download a signed PDF audit trail for any deletion request from your dashboard under Deletions → Details → Download PDF. The PDF includes the request ID, subject email, per-integration results, timestamps, duration, and a cryptographic HMAC-SHA256 signature — suitable for GDPR Article 17 compliance records.

PDF generation is available on the Startup plan and above.

PDFs are also downloadable any time from your dashboard under Deletions → Details → Download PDF (Startup plan and above).

← Back to NukeAPI · Get started free → · hello@nukeapi.dev