Returns the identity of the principal the request is authenticated as: full name, email,
current company, role, and caller type (userType). For an x-api-key request
the identity returned is the key’s owner (the key acts as the owner) and userType is
reported as apiuser; a hard-deleted (anonymized) profile is reported as
anonymous; every other caller is user. Fields resolved from the current
company/role (currentCompany, role) are null when no company context could
be resolved for the caller. For an x-api-key request, workspace and
environment name the workspace and environment the key is pinned to; both are null for a
key created before keys were scoped, and for every caller that is not a key. For a user token
(a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes
lists the workspaces and environments the token can open in the current company; it is absent
for an x-api-key request.
Identity of the principal a Developer API request is authenticated as, returned by
GET /v1/auth/whoami. For x-api-key requests the identity is the
token's owner (the key acts as the owner) and UserType is "apiuser".
userType
string
required
Caller type: "apiuser" (x-api-key), "anonymous" (deleted profile), or "user".
fullName
string | null
The acting user's full name.
email
string | null
The acting user's email address.
currentCompany
string | null
Display name of the account/company the request is scoped to.
role
string | null
Role within the current company (e.g. "Admin", "Member").
workspace
object | null
The workspace an x-api-key key is pinned to. Null for a key created before keys were scoped (it spans the whole account) and for every caller that is not a key.
Show child attributes
environment
object | null
The environment, of that workspace, an x-api-key key is pinned to. Null when the workspace is.
Show child attributes
accessibleScopes
object[] | null
For a user token: the workspaces, each with its environments, that the token can open in the current company. These are the ones the user can open in the app, cut to the workspace/environment pairs an OAuth consent limited the token to, when it did. Empty when it can open none. Without a ceiling, a workspace the user holds with no environment is listed with environments: [] (it mirrors the app's switcher, but /v1 cannot act in it); under a ceiling it is dropped. Absent for an x-api-key request, whose scope is workspace and environment.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Engini Docs","colors":{"primary":"#5533FF","light":"#D4CCFD","dark":"#0C0C0C"},"logo":{"light":"https://mintcdn.com/engini/AklLlExJ3eAXOGtW/logo/engini-lockup-light.svg?fit=max\u0026auto=format\u0026n=AklLlExJ3eAXOGtW\u0026q=85\u0026s=c0debedd989ac1aae7434afcf8929a79","dark":"https://mintcdn.com/engini/AklLlExJ3eAXOGtW/logo/engini-lockup-dark.svg?fit=max\u0026auto=format\u0026n=AklLlExJ3eAXOGtW\u0026q=85\u0026s=21df93b2081ea3e02ddd60b93533ee87"},"favicon":{"light":"https://mintcdn.com/engini/i8sQTvfL0BFarJoA/logo/favicon-light-theme.png?fit=max\u0026auto=format\u0026n=i8sQTvfL0BFarJoA\u0026q=85\u0026s=cd4460dad6b41e8f324c74cb2cdaefcf","dark":"https://mintcdn.com/engini/i8sQTvfL0BFarJoA/logo/favicon-dark-theme.png?fit=max\u0026auto=format\u0026n=i8sQTvfL0BFarJoA\u0026q=85\u0026s=b68510adf1642927b33d448bcb7bbae2"},"navbar":{"links":[{"href":"/help/getting-started/what-is-engini","label":"Help Center"},{"href":"/developers","label":"Developers"},{"href":"mailto:support@engini.io","label":"Support"}],"primary":{"type":"button","label":"Open engini","href":"https://app.engini.io"}},"footer":{"socials":{"website":"https://engini.ai","github":"https://github.com/engini"}},"fonts":{"heading":{"family":"Space Grotesk"},"body":{"family":"Inter"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"engini","hasAudioNarration":false,"actualSubdomain":"engini","customDomains":["docs.engini.ai"],"gitSource":{"type":"github","owner":"engini","repo":"engini-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afeb1f945f7499c2565e8cb","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Help Center","count":158},{"language":"default","tag":"Apps","count":142},{"language":"default","tag":"Developers","count":140},{"language":"default","tag":"API Reference","count":90},{"language":"default","tag":"Endpoints","count":89},{"language":"default","tag":"Guides","count":39},{"language":"default","tag":"Release Notes","count":35},{"language":"default","tag":"Tutorials","count":26},{"language":"default","tag":"Connections","count":23},{"language":"default","tag":"Triggers","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#topbar-cta-button>a::before{content:\"\";position:relative;z-index:10;display:block;flex:none;width:1.15em;height:1.15em;margin-right:0.4em;background-color:#ffffff;-webkit-mask:url(\"/logo/engini-symbol-mono.svg\") no-repeat center / contain;mask:url(\"/logo/engini-symbol-mono.svg\") no-repeat center / contain}.dark #topbar-cta-button>a>span{background-color:#5533ff}[data-component-part=\"products-selector-trigger\"]{display:none}@media (min-width: 1024px){#navbar div:has(>nav[aria-label=\"Main\"]),#navbar nav[aria-label=\"Main\"],#navbar nav[aria-label=\"Main\"]>ul{display:contents}#navbar div:has(>[data-component-part=\"products-selector-trigger\"]){flex:none}#navbar nav[aria-label=\"Main\"] li,#navbar div:has(>#theme-preference-menu-trigger){order:3}#navbar nav[aria-label=\"Main\"] li:has(>a[href=\"/help/getting-started/what-is-engini\"]),#navbar nav[aria-label=\"Main\"] li:has(>a[href=\"/developers\"]){order:1}#navbar nav[aria-label=\"Main\"] li:has(>a[href=\"/developers\"]){margin-right:0}#navbar div:has(>#search-bar-entry){order:2;flex:0 1 26rem;margin-inline:auto}}body:not(:has(#engini-home)) #navbar:has(a[aria-current=\"location\"][href^=\"/help\"]) nav[aria-label=\"Main\"] a[href=\"/help/getting-started/what-is-engini\"],body:not(:has(#engini-home)) #navbar:has(a[aria-current=\"location\"][href^=\"/developers\"]) nav[aria-label=\"Main\"] a[href=\"/developers\"]{color:rgb(var(--primary))}:is(.dark) body:not(:has(#engini-home)) #navbar:has(a[aria-current=\"location\"][href^=\"/help\"]) nav[aria-label=\"Main\"] a[href=\"/help/getting-started/what-is-engini\"],:is(.dark) body:not(:has(#engini-home)) #navbar:has(a[aria-current=\"location\"][href^=\"/developers\"]) nav[aria-label=\"Main\"] a[href=\"/developers\"]{color:rgb(var(--primary-light))}body:has(#engini-home) #navbar div:has(>.nav-tabs){display:none}body:has(#engini-home):has(#navbar div>.nav-tabs){--topbar-tabs-height: 0rem}"}]}
{"page":{"pagePath":"developers/api-reference/auth/who-am-i","slug":"/developers/api-reference/auth/who-am-i","pageMetadata":{"title":"Who am I","description":"Returns the identity of the principal the request is authenticated as: full name, email,\ncurrent company, role, and caller type (userType). For an x-api-key request\nthe identity returned is the key's owner (the key acts as the owner) and userType is\nreported as apiuser; a hard-deleted (anonymized) profile is reported as\nanonymous; every other caller is user. Fields resolved from the current\ncompany/role (currentCompany, role) are null when no company context could\nbe resolved for the caller. For an x-api-key request, workspace and\nenvironment name the workspace and environment the key is pinned to; both are null for a\nkey created before keys were scoped, and for every caller that is not a key. For a user token\n(a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes\nlists the workspaces and environments the token can open in the current company; it is absent\nfor an x-api-key request.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth/whoami","href":"/developers/api-reference/auth/who-am-i","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the identity of the principal the request is authenticated as: full name, email,\\ncurrent company, role, and caller type (userType). For an x-api-key request\\nthe identity returned is the key’s owner (the key acts as the owner) and userType is\\nreported as apiuser; a hard-deleted (anonymized) profile is reported as\\nanonymous; every other caller is user. Fields resolved from the current\\ncompany/role (currentCompany, role) are null when no company context could\\nbe resolved for the caller. For an x-api-key request, workspace and\\nenvironment name the workspace and environment the key is pinned to; both are null for a\\nkey created before keys were scoped, and for every caller that is not a key. For a user token\\n(a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes\\nlists the workspaces and environments the token can open in the current company; it is absent\\nfor an x-api-key request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Who am I","description":"Returns the identity of the principal the request is authenticated as: full name, email,\ncurrent company, role, and caller type (userType). For an x-api-key request\nthe identity returned is the key's owner (the key acts as the owner) and userType is\nreported as apiuser; a hard-deleted (anonymized) profile is reported as\nanonymous; every other caller is user. Fields resolved from the current\ncompany/role (currentCompany, role) are null when no company context could\nbe resolved for the caller. For an x-api-key request, workspace and\nenvironment name the workspace and environment the key is pinned to; both are null for a\nkey created before keys were scoped, and for every caller that is not a key. For a user token\n(a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes\nlists the workspaces and environments the token can open in the current company; it is absent\nfor an x-api-key request.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth/whoami","href":"/developers/api-reference/auth/who-am-i","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/engini/4837fd513836c58c/posthog.js"],"openApiReferenceData":{"operation":{"tags":["Auth"],"summary":"Who am I","description":"Returns the identity of the principal the request is authenticated as: full name, email,\ncurrent company, role, and caller type (userType). For an x-api-key request\nthe identity returned is the key's owner (the key acts as the owner) and userType is\nreported as apiuser; a hard-deleted (anonymized) profile is reported as\nanonymous; every other caller is user. Fields resolved from the current\ncompany/role (currentCompany, role) are null when no company context could\nbe resolved for the caller. For an x-api-key request, workspace and\nenvironment name the workspace and environment the key is pinned to; both are null for a\nkey created before keys were scoped, and for every caller that is not a key. For a user token\n(a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes\nlists the workspaces and environments the token can open in the current company; it is absent\nfor an x-api-key request.","operationId":"Auth_WhoAmI","responses":{"200":"2d20a8e1-582e-449b-b3d4-b11761dddd26","400":"6d93b496-8727-4aef-b84d-82614467fc08","401":"d99d921b-4ae6-4234-bc7f-e8503d3a00e4","403":"2b3a75df-74d8-43b5-bc82-49ececd4f0fc","404":"c19abe14-48c8-4740-a59f-92ef0d7987be","429":"44276bc1-6b9f-4336-ac6f-8fd17913ad0b","500":"6bbe79cb-14f8-4be8-bf8e-e735cf188c0a"},"security":["cff192bd-ad0b-4b87-962c-7fe0f8481c33","9605de88-9ca4-46d9-b00c-65e72fd8ced1"],"parameters":[],"x-codeSamples":[{"lang":"python","label":"Python","source":"from engini import Engini\n\nclient = Engini() # reads ENGINI_API_KEY\n\nme = client.auth.whoami()\nprint(me.email)"},{"lang":"typescript","label":"TypeScript","source":"import { Engini } from \"@engini/sdk\";\n\nconst client = new Engini(); // reads ENGINI_API_KEY\n\nconst me = await client.auth.whoami();\nconsole.log(me.email);"},{"lang":"bash","label":"CLI","source":"engini whoami --json"}],"method":"get","type":"path","servers":["88cde6e8-2200-4503-b575-e9d48ccab6bb"],"path":"/v1/auth/whoami","baseUrlOptions":["https://api.engini.io"],"title":"Who am I","codeSamples":[{"label":"Python","lang":"python","source":"from engini import Engini\n\nclient = Engini() # reads ENGINI_API_KEY\n\nme = client.auth.whoami()\nprint(me.email)"},{"label":"TypeScript","lang":"typescript","source":"import { Engini } from \"@engini/sdk\";\n\nconst client = new Engini(); // reads ENGINI_API_KEY\n\nconst me = await client.auth.whoami();\nconsole.log(me.email);"},{"label":"CLI","lang":"bash","source":"engini whoami --json"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"2d20a8e1-582e-449b-b3d4-b11761dddd26":{"description":"The acting principal's identity.","content":{"application/json":{"schema":{"type":"object","description":"Identity of the principal a Developer API request is authenticated as, returned by\nGET /v1/auth/whoami. For x-api-key requests the identity is the\ntoken's owner (the key acts as the owner) and UserType is \"apiuser\".","additionalProperties":false,"required":["userType"],"properties":{"userType":{"type":"string","description":"Caller type: \"apiuser\" (x-api-key), \"anonymous\" (deleted profile), or \"user\".","isRequired":true,"uniqueKey":"userType","typeLabel":"string"},"fullName":{"oneOf":[{"type":"string","description":"The acting user's full name.","uniqueKey":"fullName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The acting user's full name.","uniqueKey":"fullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fullName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"The acting user's email address.","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The acting user's email address.","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"currentCompany":{"oneOf":[{"type":"string","description":"Display name of the account/company the request is scoped to.","uniqueKey":"currentCompany.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the account/company the request is scoped to.","uniqueKey":"currentCompany.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentCompany","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","description":"Role within the current company (e.g. \"Admin\", \"Member\").","uniqueKey":"role.oneOf.0","typeLabel":"string"},{"type":"null","description":"Role within the current company (e.g. \"Admin\", \"Member\").","uniqueKey":"role.oneOf.1","typeLabel":"null"}],"uniqueKey":"role","typeLabel":"string | null"},"workspace":{"oneOf":[{"type":"object","description":"The workspace an x-api-key key is pinned to. Null for a key created before keys were scoped (it spans the whole account) and for every caller that is not a key.","required":["id"],"properties":{"id":{"type":"string","description":"The workspace id.","format":"uuid","isRequired":true,"uniqueKey":"workspace.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"The workspace's display name. Null if the workspace could not be read.","uniqueKey":"workspace.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The workspace's display name. Null if the workspace could not be read.","uniqueKey":"workspace.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"workspace.oneOf.0.name","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"workspace.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"workspace.oneOf.1","typeLabel":"null"}],"uniqueKey":"workspace","typeLabel":"object | null"},"environment":{"oneOf":[{"type":"object","description":"The environment, of that workspace, an x-api-key key is pinned to. Null when the workspace is.","required":["id"],"properties":{"id":{"type":"string","description":"The environment id.","format":"uuid","isRequired":true,"uniqueKey":"environment.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"The environment's display name. Null if the environment could not be read.","uniqueKey":"environment.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The environment's display name. Null if the environment could not be read.","uniqueKey":"environment.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"environment.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"The environment's type: \"Production\", \"Staging\" or \"Development\". Null if the environment could not be read.","uniqueKey":"environment.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The environment's type: \"Production\", \"Staging\" or \"Development\". Null if the environment could not be read.","uniqueKey":"environment.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"environment.oneOf.0.type","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"environment.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"environment.oneOf.1","typeLabel":"null"}],"uniqueKey":"environment","typeLabel":"object | null"},"accessibleScopes":{"oneOf":[{"type":"array","description":"For a user token: the workspaces, each with its environments, that the token can open in the current company. These are the ones the user can open in the app, cut to the workspace/environment pairs an OAuth consent limited the token to, when it did. Empty when it can open none. Without a ceiling, a workspace the user holds with no environment is listed with environments: [] (it mirrors the app's switcher, but /v1 cannot act in it); under a ceiling it is dropped. Absent for an x-api-key request, whose scope is workspace and environment.","items":{"type":"object","description":"A workspace a user token can open, as whoami lists it in accessibleScopes.","additionalProperties":false,"required":["id","name","environments"],"properties":{"id":{"type":"string","description":"The workspace id.","format":"uuid","isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The workspace's display name.","isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].name","typeLabel":"string"},"environments":{"type":"array","description":"The environments of this workspace the token can open. Empty when the user can open the workspace but none of its environments.","items":{"type":"object","description":"An environment a user token can open, as whoami lists it in accessibleScopes.","additionalProperties":false,"required":["id","name","type"],"properties":{"id":{"type":"string","description":"The environment id.","format":"uuid","isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].environments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The environment's display name.","isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].environments.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"The environment's type: \"Production\", \"Staging\" or \"Development\".","isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].environments.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].environments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX].environments","typeLabel":"object[]"}},"uniqueKey":"accessibleScopes.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"accessibleScopes.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"For a user token: the workspaces, each with its environments, that the token can open in the current company. These are the ones the user can open in the app, cut to the workspace/environment pairs an OAuth consent limited the token to, when it did. Empty when it can open none. Without a ceiling, a workspace the user holds with no environment is listed with environments: [] (it mirrors the app's switcher, but /v1 cannot act in it); under a ceiling it is dropped. Absent for an x-api-key request, whose scope is workspace and environment.","items":{"type":"object","description":"A workspace a user token can open, as whoami lists it in accessibleScopes.","additionalProperties":false,"required":["id","name","environments"],"properties":{"id":{"type":"string","description":"The workspace id.","format":"uuid"},"name":{"type":"string","description":"The workspace's display name."},"environments":{"type":"array","description":"The environments of this workspace the token can open. Empty when the user can open the workspace but none of its environments.","items":{"type":"object","description":"An environment a user token can open, as whoami lists it in accessibleScopes.","additionalProperties":false,"required":["id","name","type"],"properties":{"id":{"type":"string","description":"The environment id.","format":"uuid"},"name":{"type":"string","description":"The environment's display name."},"type":{"type":"string","description":"The environment's type: \"Production\", \"Staging\" or \"Development\"."}}}}}},"uniqueKey":"accessibleScopes.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessibleScopes","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"fullName":"Jane Example","email":"jane@example.com","currentCompany":"Example Co.","role":"Admin","userType":"apiuser","workspace":{"id":"00000000-0000-0000-0000-000000000000","name":"Example workspace"},"environment":{"id":"00000000-0000-0000-0000-000000000000","name":"Production","type":"Production"}},"examples":{"Example":{"title":"Example","value":{"fullName":"Jane Example","email":"jane@example.com","currentCompany":"Example Co.","role":"Admin","userType":"apiuser","workspace":{"id":"00000000-0000-0000-0000-000000000000","name":"Example workspace"},"environment":{"id":"00000000-0000-0000-0000-000000000000","name":"Production","type":"Production"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6d93b496-8727-4aef-b84d-82614467fc08":{"description":"Bad request - malformed body or invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"d99d921b-4ae6-4234-bc7f-e8503d3a00e4":{"description":"Unauthorized - missing or invalid bearer token.","content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2b3a75df-74d8-43b5-bc82-49ececd4f0fc":{"description":"Forbidden - the caller lacks access to the resource.","content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c19abe14-48c8-4740-a59f-92ef0d7987be":{"description":"Not found - the resource does not exist.","content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"44276bc1-6b9f-4336-ac6f-8fd17913ad0b":{"description":"Too many requests - rate limit exceeded.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6bbe79cb-14f8-4be8-bf8e-e735cf188c0a":{"description":"Internal server error - an unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","description":"Unified machine-readable error envelope returned by every non-200 Developer API response.","additionalProperties":false,"required":["errorCode","message","requestId","timestamp"],"properties":{"errorCode":{"type":"string","description":"Machine-readable error code identifying the failure.","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Identifier of the request, for support/correlation.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601).","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"oneOf":[{"type":"array","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"Description of the issue with the field.","isRequired":true,"uniqueKey":"details.oneOf.0.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-field validation details, when applicable.","items":{"type":"object","description":"A single field-level error detail within an ErrorResponse.","additionalProperties":false,"required":["field","issue"],"properties":{"field":{"type":"string","description":"Name of the field the issue relates to."},"issue":{"type":"string","description":"Description of the issue with the field."}}},"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","timestamp":"\u003cstring>","details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cff192bd-ad0b-4b87-962c-7fe0f8481c33":{"Bearer":{"type":"http","description":"Enter your JWT token","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}},"9605de88-9ca4-46d9-b00c-65e72fd8ced1":{"ApiKey":{"type":"apiKey","description":"Opaque Developer API key (prefix `eng_`). Authenticates as the key's owner and resolves the account automatically.","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"88cde6e8-2200-4503-b575-e9d48ccab6bb":{"url":"https://api.engini.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Enter your JWT token","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your JWT token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"},{"schemes":[{"scheme":{"type":"apiKey","description":"Opaque Developer API key (prefix `eng_`). Authenticates as the key's owner and resolves the account automatically.","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"x-api-key","type":"string","description":"Opaque Developer API key (prefix `eng_`). Authenticates as the key's owner and resolves the account automatically.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"developers/api-reference/openapi.json"},"subdomain":"engini","siteName":"Engini Docs","title":"Who am I - Engini Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T08:23:40.833Z","originalFileLocation":"developers/api-reference/auth/who-am-i.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the identity of the principal the request is authenticated as: full name, email, current company, role, and caller type (userType). For an x-api-key request the identity returned is the key\u0026#x27;s owner (the key acts as the owner) and userType is reported as apiuser; a hard-deleted (anonymized) profile is reported as anonymous; every other caller is user. Fields resolved from the current company/role (currentCompany, role) are null when no company context could be resolved for the caller. For an x-api-key request, workspace and environment name the workspace and environment the key is pinned to; both are null for a key created before keys were scoped, and for every caller that is not a key. For a user token (a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes lists the workspaces and environments the token can open in the current company; it is absent for an x-api-key request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Engini Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Who am I - Engini Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the identity of the principal the request is authenticated as: full name, email, current company, role, and caller type (userType). For an x-api-key request the identity returned is the key\u0026#x27;s owner (the key acts as the owner) and userType is reported as apiuser; a hard-deleted (anonymized) profile is reported as anonymous; every other caller is user. Fields resolved from the current company/role (currentCompany, role) are null when no company context could be resolved for the caller. For an x-api-key request, workspace and environment name the workspace and environment the key is pinned to; both are null for a key created before keys were scoped, and for every caller that is not a key. For a user token (a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes lists the workspaces and environments the token can open in the current company; it is absent for an x-api-key request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Engini Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.engini.ai/developers/api-reference/auth/who-am-i\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://engini.mintlify.site/_mintlify/api/og/v2?division=Auth\u0026amp;title=Who+am+I\u0026amp;description=Returns+the+identity+of+the+principal+the+request+is+authenticated+as%3A+full+name%2C+email%2C%0Acurrent+company%2C+role%2C+and+caller+type+%28userType%29.+For+an+x-api-key+req\u0026amp;theme=83bfac60ebabbb324d46e845\u0026amp;signature=f549523a876e6b6b77a207c9e91f28d29324b69e261cb14e56acb1c072913e1b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Who am I - Engini Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the identity of the principal the request is authenticated as: full name, email, current company, role, and caller type (userType). For an x-api-key request the identity returned is the key\u0026#x27;s owner (the key acts as the owner) and userType is reported as apiuser; a hard-deleted (anonymized) profile is reported as anonymous; every other caller is user. Fields resolved from the current company/role (currentCompany, role) are null when no company context could be resolved for the caller. For an x-api-key request, workspace and environment name the workspace and environment the key is pinned to; both are null for a key created before keys were scoped, and for every caller that is not a key. For a user token (a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes lists the workspaces and environments the token can open in the current company; it is absent for an x-api-key request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://engini.mintlify.site/_mintlify/api/og/v2?division=Auth\u0026amp;title=Who+am+I\u0026amp;description=Returns+the+identity+of+the+principal+the+request+is+authenticated+as%3A+full+name%2C+email%2C%0Acurrent+company%2C+role%2C+and+caller+type+%28userType%29.+For+an+x-api-key+req\u0026amp;theme=83bfac60ebabbb324d46e845\u0026amp;signature=f549523a876e6b6b77a207c9e91f28d29324b69e261cb14e56acb1c072913e1b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/engini/o6JYIjfH8wvKkeNu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Engini Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5533FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.engini.ai/developers/api-reference/auth/who-am-i\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api-reference/auth/who-am-i.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.engini.ai/#organization\",\"name\":\"Engini Docs\",\"url\":\"https://docs.engini.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/engini/AklLlExJ3eAXOGtW/logo/engini-lockup-light.svg?fit=max\u0026auto=format\u0026n=AklLlExJ3eAXOGtW\u0026q=85\u0026s=c0debedd989ac1aae7434afcf8929a79\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.engini.ai#website\",\"name\":\"Engini Docs\",\"url\":\"https://docs.engini.ai\",\"publisher\":{\"@id\":\"https://docs.engini.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i#webpage\",\"url\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i\",\"name\":\"Who am I\",\"description\":\"Returns the identity of the principal the request is authenticated as: full name, email, current company, role, and caller type (userType). For an x-api-key request the identity returned is the key's owner (the key acts as the owner) and userType is reported as apiuser; a hard-deleted (anonymized) profile is reported as anonymous; every other caller is user. Fields resolved from the current company/role (currentCompany, role) are null when no company context could be resolved for the caller. For an x-api-key request, workspace and environment name the workspace and environment the key is pinned to; both are null for a key created before keys were scoped, and for every caller that is not a key. For a user token (a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes lists the workspaces and environments the token can open in the current company; it is absent for an x-api-key request.\",\"dateModified\":\"2026-11-19T08:23:40.833Z\",\"isPartOf\":{\"@id\":\"https://docs.engini.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Engini Docs\",\"item\":\"https://docs.engini.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Who am I\",\"item\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i#apireference\",\"headline\":\"Who am I\",\"name\":\"Who am I\",\"description\":\"Returns the identity of the principal the request is authenticated as: full name, email, current company, role, and caller type (userType). For an x-api-key request the identity returned is the key's owner (the key acts as the owner) and userType is reported as apiuser; a hard-deleted (anonymized) profile is reported as anonymous; every other caller is user. Fields resolved from the current company/role (currentCompany, role) are null when no company context could be resolved for the caller. For an x-api-key request, workspace and environment name the workspace and environment the key is pinned to; both are null for a key created before keys were scoped, and for every caller that is not a key. For a user token (a sign-in, an OAuth access token or the 365-day Developer API token), accessibleScopes lists the workspaces and environments the token can open in the current company; it is absent for an x-api-key request.\",\"url\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engini.ai/developers/api-reference/auth/who-am-i#webpage\"},\"dateModified\":\"2026-11-19T08:23:40.833Z\",\"publisher\":{\"@id\":\"https://docs.engini.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.engini.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Engini Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Engini Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/api-reference/auth/who-am-i.md","siteName":"Engini Docs","nav":{"global":null,"products":[{"product":"Help Center","icon":"circle-question","description":"Use Engini","pages":[{"title":"Help Center","href":"/help/getting-started/what-is-engini"}]},{"product":"Developers","icon":"code","description":"Build on Engini","tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/developers"}]},{"tab":"Cookbook","pages":[{"title":"Cookbook","href":"/developers/cookbook"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/developers/sdk"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/developers/cli"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","description":"Base URL, authentication, pagination, errors, and execution semantics - everything the endpoint pages assume you know.","href":"/developers/api-reference"}]},{"group":"Endpoints","pages":[{"group":"Auth","pages":[{"title":"Who am I","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth/whoami","href":"/developers/api-reference/auth/who-am-i"}]},{"group":"Applications","pages":[{"title":"List applications","description":"Returns the applications the caller's account can browse, honoring the optional filters\nand pagination. Set available=true to restrict results to applications the caller\ncan currently use - i.e. their connection requirement is already satisfied - otherwise the\nfull catalog is returned regardless of connection state. Account context is resolved from\nthe caller's authenticated account / API key.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/applications","href":"/developers/api-reference/applications/list-applications"},{"title":"Get application","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/applications/{slug}","href":"/developers/api-reference/applications/get-application"}]},{"group":"AuthProviders","pages":[{"title":"List auth providers.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth-providers","href":"/developers/api-reference/authproviders/list-auth-providers"},{"title":"Create an auth provider.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/auth-providers","href":"/developers/api-reference/authproviders/create-an-auth-provider"},{"title":"Get an auth provider.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth-providers/{id}","href":"/developers/api-reference/authproviders/get-an-auth-provider"},{"title":"Delete an auth provider.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/auth-providers/{id}","href":"/developers/api-reference/authproviders/delete-an-auth-provider"},{"title":"Update an auth provider.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/auth-providers/{id}","href":"/developers/api-reference/authproviders/update-an-auth-provider"},{"title":"List the auth providers you can use.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth-providers/usable","href":"/developers/api-reference/authproviders/list-the-auth-providers-you-can-use"},{"title":"List the applications an auth provider can be created for.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth-providers/sources","href":"/developers/api-reference/authproviders/list-the-applications-an-auth-provider-can-be-created-for"},{"title":"Get the redirect URI for an authentication method.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/auth-providers/redirect-uri/{applicationId}","href":"/developers/api-reference/authproviders/get-the-redirect-uri-for-an-authentication-method"}]},{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections","href":"/developers/api-reference/connections/list-connections"},{"title":"Create connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/connections","href":"/developers/api-reference/connections/create-connection"},{"title":"Get connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/{connectionId}","href":"/developers/api-reference/connections/get-connection"},{"title":"Update connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json put /v1/connections/{connectionId}","href":"/developers/api-reference/connections/update-connection"},{"title":"Delete connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/connections/{connectionId}","href":"/developers/api-reference/connections/delete-connection"},{"title":"List default connections","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/defaults","href":"/developers/api-reference/connections/list-default-connections"},{"title":"Set default connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json put /v1/connections/{connectionId}/default","href":"/developers/api-reference/connections/set-default-connection"},{"title":"Clear default connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/connections/{connectionId}/default","href":"/developers/api-reference/connections/clear-default-connection"},{"title":"Replace connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/connections/replace","href":"/developers/api-reference/connections/replace-connection"},{"title":"Refresh objects","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/connections/{connectionId}/refresh-objects","href":"/developers/api-reference/connections/refresh-objects"},{"title":"Get refresh status","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/{connectionId}/refresh-status","href":"/developers/api-reference/connections/get-refresh-status"},{"title":"Select objects","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/connections/{connectionId}/select-objects","href":"/developers/api-reference/connections/select-objects"},{"title":"List connection objects","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/{connectionId}/objects","href":"/developers/api-reference/connections/list-connection-objects"},{"title":"Check connection","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/{connectionId}/check","href":"/developers/api-reference/connections/check-connection"},{"title":"Get OAuth sign-in URL","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/connections/get-sign-in-url","href":"/developers/api-reference/connections/get-oauth-sign-in-url"},{"title":"Get OAuth access token","deprecated":true,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/access-token/{state}","href":"/developers/api-reference/connections/get-oauth-access-token"},{"title":"Get sign-in status","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/connections/sign-in-status/{state}","href":"/developers/api-reference/connections/get-sign-in-status"}]},{"group":"Executions","pages":[{"title":"List executions","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/executions","href":"/developers/api-reference/executions/list-executions"},{"title":"Get execution","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/executions/{executionId}","href":"/developers/api-reference/executions/get-execution"},{"title":"Get execution log","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/executions/{executionId}/log","href":"/developers/api-reference/executions/get-execution-log"},{"title":"Get step data","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/executions/{executionId}/log/{stepNo}/data","href":"/developers/api-reference/executions/get-step-data"}]},{"group":"Folders","pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/folders","href":"/developers/api-reference/folders/list-folders"}]},{"group":"McpServers","pages":[{"title":"List MCP servers.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/mcpservers","href":"/developers/api-reference/mcpservers/list-mcp-servers"},{"title":"Get an MCP server.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/mcpservers/{mcpServerToken}","href":"/developers/api-reference/mcpservers/get-an-mcp-server"},{"title":"Update an MCP server.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/mcpservers/{mcpServerToken}","href":"/developers/api-reference/mcpservers/update-an-mcp-server"},{"title":"List the tools available to an MCP server from one of its connections.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/mcpservers/{mcpServerToken}/available-tools","href":"/developers/api-reference/mcpservers/list-the-tools-available-to-an-mcp-server-from-one-of-its-connections"}]},{"group":"On-prem agents","pages":[{"title":"List on-premise agents.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/on-prem-agents","href":"/developers/api-reference/on-prem-agents/list-on-premise-agents"},{"title":"Create an on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/on-prem-agents","href":"/developers/api-reference/on-prem-agents/create-an-on-premise-agent"},{"title":"Get an on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/on-prem-agents/{id}","href":"/developers/api-reference/on-prem-agents/get-an-on-premise-agent"},{"title":"Delete an on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/on-prem-agents/{id}","href":"/developers/api-reference/on-prem-agents/delete-an-on-premise-agent"},{"title":"Update an on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/on-prem-agents/{id}","href":"/developers/api-reference/on-prem-agents/update-an-on-premise-agent"},{"title":"Enable a disabled on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/on-prem-agents/{id}/enable","href":"/developers/api-reference/on-prem-agents/enable-a-disabled-on-premise-agent"},{"title":"Disable an on-premise agent.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/on-prem-agents/{id}/disable","href":"/developers/api-reference/on-prem-agents/disable-an-on-premise-agent"},{"title":"Read an agent's token.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/on-prem-agents/{id}/token","href":"/developers/api-reference/on-prem-agents/read-an-agents-token"},{"title":"Rotate an agent's token.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/on-prem-agents/{id}/token/rotate","href":"/developers/api-reference/on-prem-agents/rotate-an-agents-token"},{"title":"Download an agent's logs.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/on-prem-agents/{id}/logs","href":"/developers/api-reference/on-prem-agents/download-an-agents-logs"},{"title":"Get the current on-premise agent installer.","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/on-prem-agents/releases/latest","href":"/developers/api-reference/on-prem-agents/get-the-current-on-premise-agent-installer"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/tools","href":"/developers/api-reference/tools/list-tools"},{"title":"Get tool","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/tools/{toolSlug}","href":"/developers/api-reference/tools/get-tool"},{"title":"Execute tool","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/tools/{toolSlug}/execute","href":"/developers/api-reference/tools/execute-tool"}]},{"group":"Toolsets","pages":[{"title":"List toolsets","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/toolsets","href":"/developers/api-reference/toolsets/list-toolsets"},{"title":"Create toolset","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/toolsets","href":"/developers/api-reference/toolsets/create-toolset"},{"title":"Get toolset","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/toolsets/{toolsetId}","href":"/developers/api-reference/toolsets/get-toolset"},{"title":"Delete toolset","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/toolsets/{toolsetId}","href":"/developers/api-reference/toolsets/delete-toolset"},{"title":"Update toolset","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/toolsets/{toolsetId}","href":"/developers/api-reference/toolsets/update-toolset"}]},{"group":"Triggers","pages":[{"title":"List trigger types","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/types","href":"/developers/api-reference/triggers/list-trigger-types"},{"title":"Get trigger type","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/types/{triggerSlug}","href":"/developers/api-reference/triggers/get-trigger-type"},{"title":"List triggers","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers","href":"/developers/api-reference/triggers/list-triggers"},{"title":"Create trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers","href":"/developers/api-reference/triggers/create-trigger"},{"title":"Get trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/{triggerId}","href":"/developers/api-reference/triggers/get-trigger"},{"title":"Delete trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/triggers/{triggerId}","href":"/developers/api-reference/triggers/delete-trigger"},{"title":"Update trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/triggers/{triggerId}","href":"/developers/api-reference/triggers/update-trigger"},{"title":"Enable trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/{triggerId}/enable","href":"/developers/api-reference/triggers/enable-trigger"},{"title":"Disable trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/{triggerId}/disable","href":"/developers/api-reference/triggers/disable-trigger"},{"title":"Test trigger","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/{triggerId}/test","href":"/developers/api-reference/triggers/test-trigger"},{"title":"List trigger events","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/{triggerId}/events","href":"/developers/api-reference/triggers/list-trigger-events"},{"title":"Subscribe to trigger events","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/subscribe","href":"/developers/api-reference/triggers/subscribe-to-trigger-events"},{"title":"List destinations","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/destinations","href":"/developers/api-reference/triggers/list-destinations"},{"title":"Create destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/destinations","href":"/developers/api-reference/triggers/create-destination"},{"title":"Get destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/destinations/{name}","href":"/developers/api-reference/triggers/get-destination"},{"title":"Delete destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json delete /v1/triggers/destinations/{name}","href":"/developers/api-reference/triggers/delete-destination"},{"title":"Update destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json patch /v1/triggers/destinations/{name}","href":"/developers/api-reference/triggers/update-destination"},{"title":"Rotate destination secret","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/destinations/{name}/rotate-secret","href":"/developers/api-reference/triggers/rotate-destination-secret"},{"title":"Get default destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/destination","href":"/developers/api-reference/triggers/get-default-destination"},{"title":"Set default destination","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json put /v1/triggers/destination","href":"/developers/api-reference/triggers/set-default-destination"},{"title":"Get trigger event","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/triggers/events/{eventId}","href":"/developers/api-reference/triggers/get-trigger-event"},{"title":"Replay trigger event","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/triggers/events/{eventId}/replay","href":"/developers/api-reference/triggers/replay-trigger-event"}]},{"group":"Workflows","pages":[{"title":"Search the catalog","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/catalog/search","href":"/developers/api-reference/workflows/search-the-catalog"},{"title":"Get a catalog entry's schema","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/catalog/{slug}","href":"/developers/api-reference/workflows/get-a-catalog-entrys-schema"},{"title":"List field options","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/catalog/{slug}/options","href":"/developers/api-reference/workflows/list-field-options"},{"title":"List tables","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/catalog/tables","href":"/developers/api-reference/workflows/list-tables"},{"title":"List table columns","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/catalog/tables/{tableId}/columns","href":"/developers/api-reference/workflows/list-table-columns"},{"title":"List builder connections","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/connections","href":"/developers/api-reference/workflows/list-builder-connections"},{"title":"Compile a plan","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/workflows/compile","href":"/developers/api-reference/workflows/compile-a-plan"},{"title":"Get a workflow as a plan","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows/{workflowId}/plan","href":"/developers/api-reference/workflows/get-a-workflow-as-a-plan"},{"title":"List workflows","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json get /v1/workflows","href":"/developers/api-reference/workflows/list-workflows"},{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json post /v1/workflows","href":"/developers/api-reference/workflows/create-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/developers/api-reference/openapi.json put /v1/workflows/{workflowId}","href":"/developers/api-reference/workflows/update-a-workflow"}]}]}]},{"tab":"For AI Agents","pages":[{"title":"For AI Agents","href":"/developers/ai-agents"}]}]}]},"basePath":"","title":"Who am I - Engini Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}