Me API

Retrieves the unified session context for the currently authenticated user

get

This endpoint aggregates user identity, permissions, environment settings, and UI configuration into a single response optimized for front-end application initialization.

The response is cached (in memory) per session unless the refresh parameter is set to true. Only authenticated users will receive a successful response.

Query parameters

refreshbooleanOptional

When true, bypasses cached data and rebuilds the context from source systems. Defaults to false for optimal performance.

Default: false

Responses

200

Successfully retrieved user context. Returns SiteSettings object.

application/jsontext/json

TimeZoneIdstring · nullableOptional

OrganizationCodestring · nullableOptional

DomainNamestring · nullableOptional

CompanyNamestring · nullableOptional

IsCmdsbooleanOptional

UserNamestring · nullableOptional

IsAdministratorbooleanOptional

IsOperatorbooleanOptional

IsMultiOrganizationbooleanOptional

ImpersonatorNamestring · nullableOptional

StylePathstring · nullableOptional

AdminNavigationLogostring · nullableOptional

UserHostAddressstring · nullableOptional

SessionTimeoutMinutesinteger · int32Optional

PlatformSearchDownloadMaximumRowsinteger · int32Optional

PartitionEmailstring · nullableOptional

CurrentLanguagestring · nullableOptional

SupportedLanguagesstring[] · nullableOptional

RecentLinksKeystring · nullableOptional

get/api/me/context

HTTPcURLJavaScriptPython

GET /v2/e01/api/me/context HTTP/1.1
Accept: */*

200

Successfully retrieved user context. Returns SiteSettings object.

{
  "TimeZoneId": "text",
  "OrganizationCode": "text",
  "DomainName": "text",
  "CompanyName": "text",
  "IsCmds": true,
  "Home": {
    "Text": "text",
    "Url": "text",
    "Icon": "text",
    "Image": "text"
  },
  "UserName": "text",
  "IsAdministrator": true,
  "IsOperator": true,
  "IsMultiOrganization": true,
  "ImpersonatorName": "text",
  "MyDashboard": {
    "Url": "text",
    "Text": "text"
  },
  "Permissions": {
    "Accounts": true,
    "Integrations": true,
    "Settings": true
  },
  "Environment": {
    "Name": "text",
    "Version": "text",
    "Color": "text"
  },
  "StylePath": "text",
  "AdminNavigationLogo": "text",
  "UserHostAddress": "text",
  "SessionTimeoutMinutes": 1,
  "AllApps": [
    {
      "Title": "text",
      "MenuItems": [
        {
          "Url": "text",
          "Text": "text",
          "Icon": "text"
        }
      ]
    }
  ],
  "FrequentlyUsedApps": [
    {
      "Url": "text",
      "Text": "text",
      "Icon": "text"
    }
  ],
  "ShortcutGroups": [
    {
      "Url": "text",
      "Text": "text",
      "Icon": "text"
    }
  ],
  "AdminNavigationGroups": [
    {
      "Title": "text",
      "MenuItems": [
        {
          "Url": "text",
          "Text": "text",
          "Icon": "text"
        }
      ]
    }
  ],
  "PlatformSearchDownloadMaximumRows": 1,
  "PartitionEmail": "text",
  "CurrentLanguage": "text",
  "SupportedLanguages": [
    "text"
  ],
  "RecentLinksKey": "text"
}

Retrieves the list of permissions granted (or denied) to me

get

Responses

200

OK

application/jsontext/json

string[]Optional

get/api/me/permissions

HTTPcURLJavaScriptPython

GET /v2/e01/api/me/permissions HTTP/1.1
Accept: */*

200

OK

[
  "text"
]

Retrieves the list of roles to which I am assigned

get

Responses

200

OK

application/jsontext/json

string[]Optional

get/api/me/roles

HTTPcURLJavaScriptPython

GET /v2/e01/api/me/roles HTTP/1.1
Accept: */*

200

OK

[
  "text"
]