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

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

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",
  "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,
  "navigationGroups": [
    {
      "title": "text",
      "menuItems": [
        {
          "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"
  ]
}

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"
]