---
title: "Get Account Information"
method: GET
path: "/my-account"
tags: ["Account Management"]
---

# Get Account Information

`GET /my-account`

Retrieve current user's account information based on API key authentication

## Response `200`

Successful operation

- object
  - `name` string, required — User's full name
  - `email` string, email, required — User's email address
  - `companies` Company[] — List of companies, including each company's webhook configuration (only present if user has companies configured)
    - `_id` string — ObjectId of the company
    - `name` string — Display name of the company
    - `data` object — Company assets used to scope searches
      - `domains` string[] — Primary domains owned by the company
      - `apks` string[] — Android application package names associated with the company
      - `external_domains` string[] — External (third-party) domains associated with the company
      - `webhook` Webhook, nullable — Webhook configuration for notifying an external endpoint of events related to a company. Null if not configured.
        - `url` string, uri — HTTPS URL to receive webhook notifications.
        - `token` string — Token sent with each webhook request to authenticate it (e.g. a Splunk HEC token or bearer token).
        - `auth_header` string — Name of the HTTP header used to send the token. Defaults to "Authorization" if not specified.
  - `domains` string[] — List of domains (only present if user doesn't have companies)
  - `external_domains` string[] — List of external domains (only present if user doesn't have companies)
  - `apps` string[] — List of apps (only present if user doesn't have companies)
  - `alert_emails` string[], required — List of email addresses for alerts
  - `date_created` string, date-time, required — Account creation date
  - `organization` object — Organization the user belongs to (omitted if the user is not part of an organization). Use this to determine whether company management endpoints will be allowed: when `synced_data` is true, only members with `role: "owner"` may add, remove, or modify companies.
    - `name` string — Organization name
    - `role` 'owner' | 'member' — User's role within the organization
    - `synced_data` boolean — If true, all members share the owner's companies. Only the owner may modify companies through the API.
    - `synced_archive` boolean — If true, the organization's archive is synced across members.
    - `date` string, date-time — Date the user joined the organization
  - `permissions` object — User's API permissions organized by category
    - `data` object
      - `label` string
      - `permissions` object[]
        - `id` string
        - `label` string
        - `description` string
    - `search` object
      - `label` string
      - `permissions` object[]
        - `id` string
        - `label` string
        - `description` string
    - `visibility` object
      - `label` string
      - `permissions` string[] — Array of field names the user can access
    - `filtering` object
      - `label` string
      - `permissions` object[]
        - `id` string
        - `label` string
        - `description` string

## Other responses

- `401` — Unauthorized - the server could not authenticate the request
- `404` — User not found
- `500` — Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request

---

[API](https://skmtc.net/hudsonrock/apis/cavalier-api.md) · [All operations](https://skmtc.net/hudsonrock/apis/cavalier-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hudsonrock/cavalier-api/revisions/5ba0142eec4d/schema)