---
title: "MyCompany"
method: GET
path: "/companies/me"
tags: ["MyCompany"]
---

# MyCompany

`GET /companies/me`

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `publicId` string
    - `name` string
    - `country` string
    - `defaultUserInviteLanguage` string
    - `supportAccessExpiresOn` string, date-time, nullable
    - `appOwnerName` string, nullable
    - `custom` object
    - `branding` object, nullable
      - `publicId` string
      - `name` string, nullable
      - `fqdn` string, nullable
      - `theme` object, nullable
        - `primaryColor` string
        - `primaryTextColor` string
        - `accentColor` string, nullable
        - `accentTextColor` string, nullable
        - `headerColor` string, nullable
        - `headerLineColor` string, nullable
        - `menuColor` string, nullable
        - `menuTextColor` string, nullable
        - `pageColor` string, nullable
        - `pageTextColor` string, nullable
        - `cardColor` string, nullable
        - `cardTextColor` string, nullable
        - `logoHasBackgroundColor` boolean
        - `logoOnHeaderColorSpec` string, nullable
      - `appleTouchIcon` string, nullable
      - `favicon` string, nullable
      - `logo` string, nullable
      - `logoDark` string, nullable
      - `appleAppStoreLink` string, nullable
      - `googlePlayStoreLink` string, nullable
      - `landingPageComponentTemplate` object, nullable
        - `publicId` string
        - `company` object, nullable
          - `publicId` string
        - `name` string
        - `description` string, nullable
        - `version` string, nullable
        - `author` string, nullable
        - `licence` string, nullable
        - `url` string, nullable
        - `sheetSettings` object, nullable
          - `minCols` integer
          - `defaultCols` integer, nullable
          - `maxCols` integer, nullable
          - `minRows` integer
          - `defaultRows` integer, nullable
          - `maxRows` integer, nullable
        - `cardSettings` object, nullable
          - `minHeight` integer
          - `defaultHeight` integer, nullable
          - `maxHeight` integer, nullable
        - `inputs` string, nullable
        - `draft` object, nullable
          - `publicId` string
        - `published` object, nullable
          - `publicId` string
        - `category` object
          - `publicId` string
          - `name` string
          - `order` integer
        - `configuredVersion` object, nullable
          - `publicId` string
          - `number` string
          - `mainPath` string
        - `backendComponent` object, nullable
          - `publicId` string
        - `static` boolean
        - `intent` string[]
        - `private` boolean
      - `custom` object
    - `screensaver` object, nullable
      - `publicId` string
    - `requireDedicatedRscServer` boolean
    - `requireDedicatedMdrServer` boolean
    - `loggingTrialUsed` boolean
    - `alarmingTrialUsed` boolean
    - `premiumLicence` object, nullable
      - `publicId` string
      - `type` object
        - `publicId` string
        - `usageType` 'advanced-user-management' | 'agent-registration-profile' | 'agent-templates' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'edge-app-management' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage'
        - `companyLimit` integer, nullable
        - `scope` 'agent' | 'company'
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
        - `publicId` string
        - `name` string
    - `premiumLicenceStatus` 'not-configured' | 'pending' | 'activated', nullable
    - `reportingLicence` object, nullable
      - `publicId` string
      - `type` object
        - `publicId` string
        - `usageType` 'advanced-user-management' | 'agent-registration-profile' | 'agent-templates' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'edge-app-management' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage'
        - `companyLimit` integer, nullable
        - `scope` 'agent' | 'company'
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
        - `publicId` string
        - `name` string
    - `slaLicence` object, nullable
      - `publicId` string
      - `type` object
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
    - `vpnUsageLicence` object, nullable
      - `publicId` string
      - `type` object
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
    - `vpnAccessRuleLicence` object, nullable
      - `publicId` string
      - `type` object
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
    - `assetManagementLicence` object, nullable
      - `publicId` string
      - `type` object
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
    - `mobileAppLicence` object, nullable
      - `publicId` string
      - `type` object
      - `serialNumber` string
      - `expiresOn` string, date-time, nullable
      - `activated` boolean
      - `trial` boolean
      - `value` string, nullable
      - `locked` boolean, nullable
      - `maxRetentionPolicy` string, nullable
      - `bundle` object, nullable
    - `mobileAppLicenceStatus` 'not-configured' | 'pending' | 'activated', nullable
    - `licenceModel` 'legacy' | 'modules'
    - `customTermsOfUse` 'sector' | 'company' | 'disabled'
    - `customPrivacyStatement` 'sector' | 'company' | 'disabled'
    - `latestTermsOfUse` object
      - `publicId` string
      - `company` object, nullable
        - `publicId` string
      - `latest` boolean, nullable
      - `version` string, nullable
      - `publishedOn` string, date-time, nullable
      - `downloadUrl` string, nullable
      - `type` 'termsofuse' | 'privacystatement'
      - `languages` object[]
        - `publicId` string
        - `languageCode` string
        - `body` string
        - `updateSummary` string, nullable
        - `policy` object
          - `publicId` string
    - `latestPrivacyStatement` object
      - `publicId` string
      - `company` object, nullable
        - `publicId` string
      - `latest` boolean, nullable
      - `version` string, nullable
      - `publishedOn` string, date-time, nullable
      - `downloadUrl` string, nullable
      - `type` 'termsofuse' | 'privacystatement'
      - `languages` object[]
        - `publicId` string
        - `languageCode` string
        - `body` string
        - `updateSummary` string, nullable
        - `policy` object
          - `publicId` string
    - `shellAgentLimit` integer, nullable
    - `createdOn` string, date-time, nullable

## Other responses

- `4XX` — 4XX error response

---

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