# Me API

## Retrieves the unified session context for the currently authenticated user

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"paths":{"/api/me/context":{"get":{"tags":["Me API"],"summary":"Retrieves the unified session context for the currently authenticated user","description":"This endpoint aggregates user identity, permissions, environment settings, and UI configuration\r\ninto a single response optimized for front-end application initialization.\r\n\r\nThe response is cached (in memory) per session unless the refresh parameter is set to true. Only authenticated \r\nusers will receive a successful response.","parameters":[{"name":"refresh","in":"query","description":"When true, bypasses cached data and rebuilds the context from source systems.\r\nDefaults to false for optimal performance.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successfully retrieved user context. Returns SiteSettings object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteSettings"}},"text/json":{"schema":{"$ref":"#/components/schemas/SiteSettings"}}}}}}}},"components":{"schemas":{"SiteSettings":{"type":"object","properties":{"timeZoneId":{"type":"string","nullable":true},"organizationCode":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"isCmds":{"type":"boolean"},"home":{"$ref":"#/components/schemas/HomeSettings"},"userName":{"type":"string","nullable":true},"isAdministrator":{"type":"boolean"},"isOperator":{"type":"boolean"},"isMultiOrganization":{"type":"boolean"},"impersonatorName":{"type":"string","nullable":true},"myDashboard":{"$ref":"#/components/schemas/LinkModel"},"permissions":{"$ref":"#/components/schemas/PermissionsModel"},"environment":{"$ref":"#/components/schemas/EnvironmentModel"},"stylePath":{"type":"string","nullable":true},"adminNavigationLogo":{"type":"string","nullable":true},"userHostAddress":{"type":"string","nullable":true},"sessionTimeoutMinutes":{"type":"integer","format":"int32"},"navigationGroups":{"type":"array","items":{"$ref":"#/components/schemas/MenuModel"},"nullable":true},"shortcutGroups":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true},"adminNavigationGroups":{"type":"array","items":{"$ref":"#/components/schemas/MenuModel"},"nullable":true},"platformSearchDownloadMaximumRows":{"type":"integer","format":"int32"},"partitionEmail":{"type":"string","nullable":true},"currentLanguage":{"type":"string","nullable":true},"supportedLanguages":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"HomeSettings":{"type":"object","properties":{"text":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true},"image":{"type":"string","nullable":true}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"url":{"type":"string","nullable":true},"text":{"type":"string","nullable":true}},"additionalProperties":false},"PermissionsModel":{"type":"object","properties":{"accounts":{"type":"boolean"},"integrations":{"type":"boolean"},"settings":{"type":"boolean"}},"additionalProperties":false},"EnvironmentModel":{"type":"object","properties":{"name":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"color":{"type":"string","nullable":true}},"additionalProperties":false},"MenuModel":{"type":"object","properties":{"title":{"type":"string","nullable":true},"menuItems":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"nullable":true}},"additionalProperties":false},"MenuLinkModel":{"type":"object","properties":{"url":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"icon":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## GET /api/me/permissions

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

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"paths":{"/api/me/permissions":{"get":{"tags":["Me API"],"summary":"Retrieves the list of permissions granted (or denied) to me","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## GET /api/me/roles

> Retrieves the list of roles to which I am assigned

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"paths":{"/api/me/roles":{"get":{"tags":["Me API"],"summary":"Retrieves the list of roles to which I am assigned","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```