Skip to content

Personal Profile Endpoints ​

Manage the authenticated user's Personal Intelligence Profile — sensitivity settings, personal terms, and onboarding state.

Authentication

All endpoints require a valid bearer token. Operations are scoped to the authenticated user's profile.

Get Personal Profile ​

Retrieve the current user's Personal Intelligence Profile.

GET /api/intelligence-profiles/personal

Response ​

json
{
  "user_id": "usr_abc123",
  "sensitivity_dial": "balanced",
  "onboarding_dismissed": false,
  "term_count": 12,
  "effective_sensitivity": "balanced",
  "company_floor": "balanced",
  "created_at": "2026-01-05T09:00:00Z",
  "updated_at": "2026-02-20T16:45:00Z"
}
FieldTypeDescription
user_idstringUser identifier
sensitivity_dialstringUser's chosen sensitivity: relaxed, balanced, paranoid
onboarding_dismissedbooleanWhether the user has completed or dismissed onboarding
term_countnumberNumber of personal terms registered
effective_sensitivitystringResolved sensitivity after applying the company floor
company_floorstringOrganization's Sensitivity Floor setting
created_atstringProfile creation timestamp (ISO 8601)
updated_atstringLast modification timestamp (ISO 8601)

Update Personal Profile ​

Update the user's sensitivity settings.

PUT /api/intelligence-profiles/personal

Request ​

json
{
  "sensitivity_dial": "paranoid"
}
FieldTypeRequiredDescription
sensitivity_dialstringNorelaxed, balanced, or paranoid

Response ​

Returns the updated profile (same schema as GET).

Sensitivity Floor

If the organization's Sensitivity Floor is higher than your chosen setting, effective_sensitivity will reflect the floor value, not your dial setting.

Delete Personal Profile ​

Remove the user's Personal Intelligence Profile entirely. This deletes all personal terms and resets sensitivity settings to the company baseline.

DELETE /api/intelligence-profiles/personal

Response ​

Status: 204 No Content

WARNING

This action is irreversible. All personal terms and settings are permanently deleted.

Dismiss Onboarding ​

Mark the onboarding flow as dismissed so it is no longer shown.

POST /api/intelligence-profiles/personal/dismiss-onboarding

Response ​

json
{
  "onboarding_dismissed": true
}

List Personal Terms ​

Retrieve the user's personal sensitive terms.

GET /api/intelligence-profiles/personal/terms

Parameters ​

ParameterInTypeRequiredDescription
categoryquerystringNoFilter by category
pagequerynumberNoPage number (default: 1)
per_pagequerynumberNoItems per page (default: 50, max: 200)

Response ​

json
{
  "terms": [
    {
      "id": "pterm_r7s8t9",
      "term": "Project Nightingale",
      "category": "project_codename",
      "sensitivity": "high",
      "created_at": "2026-02-10T11:00:00Z"
    },
    {
      "id": "pterm_u1v2w3",
      "term": "Jane Prospect",
      "category": "customer_name",
      "sensitivity": "medium",
      "created_at": "2026-02-14T09:30:00Z"
    }
  ],
  "total": 12,
  "page": 1,
  "per_page": 50
}

Add Personal Term ​

Register a new personal sensitive term.

POST /api/intelligence-profiles/personal/terms

Request ​

json
{
  "term": "Project Nightingale",
  "category": "project_codename",
  "sensitivity": "high"
}
FieldTypeRequiredDescription
termstringYesWord or phrase to detect (case-insensitive)
categorystringYesClassification category
sensitivitystringNolow, medium, high, critical — defaults to category default

Response ​

json
{
  "id": "pterm_r7s8t9",
  "term": "Project Nightingale",
  "category": "project_codename",
  "sensitivity": "high",
  "created_at": "2026-02-25T10:00:00Z"
}

Status: 201 Created

Delete Personal Term ​

Remove a personal term.

DELETE /api/intelligence-profiles/personal/terms/{termId}

Parameters ​

ParameterInTypeRequiredDescription
termIdpathstringYesPersonal term ID to delete

Response ​

Status: 204 No Content

Get Merged Terms ​

Retrieve the effective term list combining company and personal terms. Company term details are appropriately scoped — the user sees that a company term exists and its category, but sensitive metadata is redacted.

GET /api/intelligence-profiles/merged-terms

Parameters ​

ParameterInTypeRequiredDescription
categoryquerystringNoFilter by category
pagequerynumberNoPage number (default: 1)
per_pagequerynumberNoItems per page (default: 50, max: 200)

Response ​

json
{
  "terms": [
    {
      "id": "term_x1y2z3",
      "term": "Project Falcon",
      "category": "project_codename",
      "sensitivity": "critical",
      "source": "company",
      "created_at": "2026-01-10T08:00:00Z"
    },
    {
      "id": "pterm_r7s8t9",
      "term": "Project Nightingale",
      "category": "project_codename",
      "sensitivity": "high",
      "source": "personal",
      "created_at": "2026-02-10T11:00:00Z"
    }
  ],
  "total": 54,
  "page": 1,
  "per_page": 50,
  "company_term_count": 42,
  "personal_term_count": 12
}
FieldTypeDescription
sourcestringcompany or personal — indicates which profile owns the term
company_term_countnumberTotal company terms in the merged set
personal_term_countnumberTotal personal terms in the merged set

Error Responses ​

StatusDescription
400Invalid request body or parameters
401Missing or invalid authentication token
404Profile or term not found
409Duplicate term
422Validation error (e.g., invalid category)
json
{
  "error": "not_found",
  "message": "Personal Intelligence Profile not found. Complete onboarding to create one.",
  "status": 404
}

SOC 2 Type II Certified | BAA Available | HIPAA-Ready