> For the complete documentation index, see [llms.txt](https://docs.shiftiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiftiq.com/developers/api-v2/navigating-the-api/me-api.md).

# 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},"DomainName":{"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"},"AllApps":{"type":"array","items":{"$ref":"#/components/schemas/MenuModel"},"nullable":true},"FrequentlyUsedApps":{"type":"array","items":{"$ref":"#/components/schemas/MenuLinkModel"},"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},"RecentLinksKey":{"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"}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.shiftiq.com/developers/api-v2/navigating-the-api/me-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.