Skip to main content

Account and privacy

Read and update your profile, export your data, delete your account, and file a data-subject erasure request.

On this page
GET /api/v1/users/me
Your profile.
PUT /api/v1/users/me
Update profile fields.
GET /api/v1/users/me/export
Export your data as JSON. Recent interactive session only.
DELETE /api/v1/users/me
Delete your account. Recent interactive session only.
POST /api/v1/gdpr/deletion-requests
File an erasure request for review.
GET /api/v1/gdpr/deletion-requests/me
Your most recent erasure request.

Profile

GET /users/me returns your id, email and verification state, name, role, organization id, avatar and the profile fields you set. PUT /users/me accepts any of name, email, country, job_title, company, industry, use_case and phone; omitted fields are unchanged.

Export and delete

Both operations need a console session token issued within the last five minutes, so they cannot be called with an API key. Sign in again first.

  • Export returns your account, your organization memberships and your API key metadata (never key secrets), with generated_at and export_version.
  • Delete is immediate and irreversible. The response reports how many rows were removed.

Erasure requests

POST /gdpr/deletion-requests files a data-subject erasure request with an optional reason (up to 2,000 characters). It is idempotent: if you already have an open request, that request is returned instead of a new one. Requests move through pending, then optionally approved, and end as completed, failed or rejected. Check progress with GET /gdpr/deletion-requests/me.

File a request
curl -X POST https://api.breachline.io/api/v1/gdpr/deletion-requests \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Closing our account"}'

Search documentation

Type to search guides, the API reference, the CLI and the console guide.

    Enter open↑ ↓ moveEsc close