Account

API version

2026-11-11 (latest)next (preview)

PreviewDownload OpenAPI (JSON)Versioning

Preview

next shows changes that are not released or not stable yet. Use the current version for production integrations.

Get your profile

GET /api/v1/users/me

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Responses

• 200 The profile.

  application/json

  Body (application/json)

  • id string
  • email string (email)
  • email_verified boolean
  • name string or null
  • role string or null
  • organization_id string or null
  • avatar_url string or null
  • company string or null
  • country string or null
  • industry string or null
  • job_title string or null
  • phone string or null
  • use_case string or null
  • created_at string or null
  • updated_at string or null
• 401 Missing, invalid, expired or revoked credentials.Error envelope

Example

cURLCopy

curl "https://api.breachline.io/api/v1/users/me" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY"

Example 200 responseCopy

{
  "id": "string",
  "email": "string",
  "email_verified": true,
  "name": "string",
  "role": "string",
  "organization_id": "string",
  "avatar_url": "string",
  "company": "string",
  "country": "string",
  "industry": "string",
  "job_title": "string",
  "phone": "string",
  "use_case": "string",
  "created_at": "string",
  "updated_at": "string"
}

Update your profile

PUT /api/v1/users/me

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Request body

application/json Required

• name string or null
• email string (email) or null
• country string or null

  Maximum length

  120

• job_title string or null

  Maximum length

  120

• company string or null

  Maximum length

  200

• industry string or null

  Maximum length

  120

• use_case string or null

  Maximum length

  500

• phone string or null

  Maximum length

  40

Responses

• 200 The updated profile.

  application/json

  Body (application/json)

  • id string
  • email string (email)
  • email_verified boolean
  • name string or null
  • role string or null
  • organization_id string or null
  • avatar_url string or null
  • company string or null
  • country string or null
  • industry string or null
  • job_title string or null
  • phone string or null
  • use_case string or null
  • created_at string or null
  • updated_at string or null
• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 422 The request body or parameters failed schema validation.Error envelope

Example

cURLCopy

curl -X PUT "https://api.breachline.io/api/v1/users/me" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example 200 responseCopy

{
  "id": "string",
  "email": "string",
  "email_verified": true,
  "name": "string",
  "role": "string",
  "organization_id": "string",
  "avatar_url": "string",
  "company": "string",
  "country": "string",
  "industry": "string",
  "job_title": "string",
  "phone": "string",
  "use_case": "string",
  "created_at": "string",
  "updated_at": "string"
}

Delete your account

DELETE /api/v1/users/me Session only

Irreversible. Needs a console session token issued within the last 5 minutes, so API keys cannot call it.

Authentication

• Console session token only (API keys are refused)

Responses

• 200 Deleted.

  application/json

  Body (application/json)

  • reason string
  • rows_deleted integer
• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 403 The credential is valid but lacks a required scope or permission.Error envelope

Example

cURLCopy

curl -X DELETE "https://api.breachline.io/api/v1/users/me" \
  -H "Authorization: Bearer $BREACHLINE_SESSION_TOKEN"

Example 200 responseCopy

{
  "reason": "string",
  "rows_deleted": 0
}

Export your data

GET /api/v1/users/me/export Session only

A JSON export of your account, memberships and API key metadata. Needs a console session token issued within the last 5 minutes.

Authentication

• Console session token only (API keys are refused)

Responses

• 200 The export.

  application/json

  Body (application/json)

  • export_version string or integer
  • generated_at string (date-time)
  • user_id string
  • account object
  • memberships array of objects
  • api_keys array of objects
  • note string
• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 403 The credential is valid but lacks a required scope or permission.Error envelope

Example

cURLCopy

curl "https://api.breachline.io/api/v1/users/me/export" \
  -H "Authorization: Bearer $BREACHLINE_SESSION_TOKEN"

Example 200 responseCopy

{
  "export_version": "string",
  "generated_at": "2026-11-11T00:00:00Z",
  "user_id": "string",
  "account": {},
  "memberships": [
    {}
  ],
  "api_keys": [
    {}
  ],
  "note": "string"
}