v1

latestOpenAPI 3.0.02026-07-24311994.6 KB

Account Management

Get Account Information

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

get/my-account

Response

Successful operation

namestring required

User's full name

emailstring email required

User's email address

domainsstring[]

List of domains (only present if user doesn't have companies)

external_domainsstring[]

List of external domains (only present if user doesn't have companies)

appsstring[]

List of apps (only present if user doesn't have companies)

alert_emailsstring[] required

List of email addresses for alerts

date_createdstring date-time required

Account creation date

Example response

{
  "name": "John Doe",
  "email": "john.doe@company.com",
  "companies": [
    {
      "_id": "65f0a1b2c3d4e5f6a7b8c9d0",
      "name": "Acme Corp",
      "data": {
        "domains": [
          "acme.com"
        ],
        "apks": [
          "com.acme.app"
        ],
        "external_domains": [
          "vendor.com"
        ],
        "webhook": {
          "url": "https://example.com/webhooks/acme",
          "token": "11111111-2222-3333-4444-555555555555",
          "auth_header": "Authorization"
        }
      }
    }
  ],
  "organization": {
    "name": "Acme Inc"
  },
  "permissions": {
    "data": {
      "label": "Data Access Permissions"
    },
    "search": {
      "label": "Search Endpoint Permissions"
    },
    "visibility": {
      "label": "Field Visibility Permissions"
    },
    "filtering": {
      "label": "Filtering & Scope Controls"
    }
  }
}