Invites a single person to your organization. The same call also resends an existing invitation: posting an address that already has a live invitation resends it rather than creating a second one.Inviting someone provisions them immediately as a pending member of the organization. With workspaces, the same call also places them in workspaces, each with a role, so you can add them to permission groups and grant them access in those workspaces before they accept. See Pending users and pre-granted invitations below.
Request body
Parameter
Type
Required
Description
email
string
Yes
The address to invite. Normalized before storing, so casing never creates a duplicate.
organization_role
string
No
The invitee’s role in the organization: owner, admin, or member. Defaults to member.
workspaces
array
No
Workspaces to place the invitee in right away, each as {"workspace": "<workspace id>", "role": "admin" | "member"}. No workspace can appear twice.
first_name
string
No
Shown in the member list before the person accepts.
last_name
string
No
Shown in the member list before the person accepts.
functional_area
string
No
The invitee’s functional area.
other_functional_area
string
No
Free-text functional area, when none of the predefined options fit.
Organization owners and admins are admins of every workspace. When organization_role is owner or admin, omit workspaces, or list every active workspace of the organization with the admin role. Any other list is rejected with 400 (workspaces_inconsistent_with_role).
The invitation belongs to the organization even when it names workspaces: it is listed and revoked through the organization’s invitations.
Response
Returns the Organization invitation object. The status code tells you which of the two things happened:
201 Created: a new invitation was created.
200 OK: an existing invitation was resent.
The response includes user, the id of the pending user the invitation created. You can use it immediately as a grant or group target.
Sending the same address again is safe and is how you chase someone who has not accepted. Nobody is duplicated: the existing invitation is resent with a fresh expiry, and the invitee’s existing groups and grants are untouched.If organization_role differs from the outstanding invitation, the resend is a role change: it moves the person on both the invitation and their pending membership.
Moving an existing admin or owner invitee to another role requires an owner. This is the same ceiling that applies to changing the role of an accepted member.
Pending users and pre-granted invitations
Because an invitation provisions the person right away, they exist as a pending member the moment the call succeeds:
Grant access before acceptance. In every workspace the invitee was placed in, a pending member is a normal target for every permission-assign endpoint, and can be added to a permission group with no separate flow.
Pending is not inactive. In the member list a pending member carries its own status; it is not the same as a deactivated user.
They cannot log in until they accept. The invitation token is the only proof that the person controls the address.
Revoking is destructive.Revoking removes the invitee’s workspaces, groups, and grants, not just the email.
The invitation email expires after 7 days; the pre-granted access does not. An admin resends and nothing has to be re-granted.
Authentication
This endpoint requires an API key in the x-api-key header.Only an organization owner or admin can invite, and nobody can invite somebody to an organization role above their own. For an API key, that ceiling is read from the organization role of the user who created the key.An API key belongs to one workspace, so through a key workspaces can only name the key’s own workspace. Any other workspace is rejected with 400.
Errors
Status
When
400
The address already belongs to an active member of the organization.
400
email is missing or malformed.
400
A workspace in workspaces is not an active workspace of your organization, is not reachable by the API key, or appears twice.
400
workspaces_inconsistent_with_role: the request makes the invitee an owner or admin and workspaces does not list every workspace as admin.
403
The caller is a member, or the request names an organization role above the caller’s own.
403
The request changes the role of an existing admin or owner invitee and the caller is not an owner.
403
The organization is on the Free plan, where only owners may be invited.
Related
Onboarding flow: invite, group, and grant before somebody accepts.
An invitation as organization/invitations/ answers it: invitations/'s fields, plus the user
it created (pending in the organization until they accept) and the workspace it was issued in
(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). created_by,
user and workspace are ids, each expandable. organization_role is the role in the organization
the invitation grants, invitations/'s role.
email
string<email>
required
Maximum string length: 254
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
organization_role
enum<string>
default:member
The invitee's role in the organization. Defaults to member. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.
owner - Owner
admin - Admin
member - Member
Available options:
owner,
admin,
member
functional_area
Option 1 · enum<string>Option 2 · enum<string>Option 3 · any
data_analytics - Data & Analytics
sales - Sales
customer_support - Customer Support
operations - Operations
marketing - Marketing
finance - Finance
product_development - Product Development
growth - Growth
executive_leadership - Executive Leadership
other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
Maximum string length: 128
workspaces
object[]
write-only
Workspaces to place the invitee in right away, each with their role there; the invitation still belongs to the organization. An owner or admin is an admin of every workspace: omit workspaces for them, or list every workspace as admin. No workspace twice.
Show child attributes
Response
201 - application/json
An invitation as organization/invitations/ answers it: invitations/'s fields, plus the user
it created (pending in the organization until they accept) and the workspace it was issued in
(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). created_by,
user and workspace are ids, each expandable. organization_role is the role in the organization
the invitation grants, invitations/'s role.
id
string<uuid>
required
read-only
email
string<email>
required
Maximum string length: 254
sent_at
string<date-time>
required
read-only
expires_at
string<date-time>
required
read-only
accepted_at
string<date-time> | null
required
read-only
revoked_at
string<date-time> | null
required
read-only
created_at
string<date-time>
required
read-only
created_by
integer
required
read-only
The user who sent the invitation. (Expandable)
user
integer | null
required
read-only
The user the invitation created, pending in the organization until they accept. (Expandable)
workspace
string<uuid> | null
required
read-only
The workspace the invitation was issued in; null for an organization invitation. (Expandable)
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
organization_role
enum<string>
default:member
The invitee's role in the organization. Defaults to member. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.
owner - Owner
admin - Admin
member - Member
Available options:
owner,
admin,
member
functional_area
Option 1 · enum<string>Option 2 · enum<string>Option 3 · any
data_analytics - Data & Analytics
sales - Sales
customer_support - Customer Support
operations - Operations
marketing - Marketing
finance - Finance
product_development - Product Development
growth - Growth
executive_leadership - Executive Leadership
other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
Maximum string length: 128
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nekt","colors":{"primary":"#097860","light":"#FAF9F7","dark":"#222427"},"logo":{"light":"https://mintcdn.com/nekt/fAFtC-RZLnUKCv7c/assets/logo/light.svg?fit=max\u0026auto=format\u0026n=fAFtC-RZLnUKCv7c\u0026q=85\u0026s=cba8701f886607d770a7510c525d81b7","dark":"https://mintcdn.com/nekt/fAFtC-RZLnUKCv7c/assets/logo/dark.svg?fit=max\u0026auto=format\u0026n=fAFtC-RZLnUKCv7c\u0026q=85\u0026s=49a92921377751229bc12ae4b61b1c6a"},"favicon":"https://mintcdn.com/nekt/DJnjRR_rS7CNJfYV/favicon.png?fit=max\u0026auto=format\u0026n=DJnjRR_rS7CNJfYV\u0026q=85\u0026s=4df461957abd65599739f5ec1c8c84cf","api":{"openapi":{"source":"https://api.nekt.ai/api/schema/"},"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.nekt.ai/"}},"background":{"color":{"light":"#FAF9F7","dark":"#222427"}},"navbar":{"primary":{"type":"button","label":"Platform","href":"https://app.nekt.ai"}},"footer":{"socials":{"website":"https://nekt.com","linkedin":"https://www.linkedin.com/company/nektai","youtube":"https://www.youtube.com/@nektdata","github":"https://github.com/nektcom"}},"integrations":{"ga4":{"measurementId":"G-8YEZ2TKV3C"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nekt","hasAudioNarration":false,"actualSubdomain":"nekt","customDomains":["docs.nekt.com"],"gitSource":{"type":"github","owner":"nektcom","repo":"nekt-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afdf16807021093942ba806","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":568},{"language":"default","tag":"Connectors","count":501},{"language":"default","tag":"Context","count":459},{"language":"default","tag":"Sources","count":449},{"language":"default","tag":"Platform API","count":151},{"language":"default","tag":"Activate","count":78},{"language":"default","tag":"Destinations","count":61},{"language":"default","tag":"Permissions","count":34},{"language":"default","tag":"Catalog","count":24},{"language":"default","tag":"MCP Server","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":false},"customCss":[{"filePath":"style.css","content":"#content-area a{text-underline-offset:2px;transition:opacity 0.15s ease}#content-area a:hover{opacity:0.7}#content-area a.card{text-decoration:none}a[href*=\"utm_campaign=poweredBy\"]{display:none}"}],"page":{"pagePath":"platform-api/invitations/organization/invite","slug":"/platform-api/invitations/organization/invite","pageMetadata":{"title":"Invite User","sidebarTitle":"Invite User","description":"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.","openapi":"POST /api/v1/organization/invitations/","href":"/platform-api/invitations/organization/invite"},"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: \"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Invites a single person to your organization. The same call also `,_jsx(_components.strong,{children:`resends`}),` an existing invitation: posting an address that already has a live invitation resends it rather than creating a second one.`]}),`\n`,_jsxs(_components.p,{children:[`Inviting someone provisions them immediately as a `,_jsx(_components.strong,{children:`pending member`}),` of the organization. With `,_jsx(_components.code,{children:`workspaces`}),`, the same call also places them in workspaces, each with a role, so you can add them to permission groups and grant them access in those workspaces before they accept. See `,_jsx(_components.a,{href:`#pending-users-and-pre-granted-invitations`,children:`Pending users and pre-granted invitations`}),` below.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request body`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`email`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`The address to invite. Normalized before storing, so casing never creates a duplicate.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`organization_role`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`The invitee’s role in the organization: `,_jsx(_components.code,{children:`owner`}),`, `,_jsx(_components.code,{children:`admin`}),`, or `,_jsx(_components.code,{children:`member`}),`. Defaults to `,_jsx(_components.code,{children:`member`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`workspaces`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Workspaces to place the invitee in right away, each as `,_jsx(_components.code,{children:`{\"workspace\": \"\u003cworkspace id>\", \"role\": \"admin\" | \"member\"}`}),`. No workspace can appear twice.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`first_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Shown in the member list before the person accepts.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`last_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Shown in the member list before the person accepts.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`functional_area`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`The invitee’s functional area.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`other_functional_area`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Free-text functional area, when none of the predefined options fit.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Organization owners and admins are admins of every workspace. When `,_jsx(_components.code,{children:`organization_role`}),` is `,_jsx(_components.code,{children:`owner`}),` or `,_jsx(_components.code,{children:`admin`}),`, omit `,_jsx(_components.code,{children:`workspaces`}),`, or list every active workspace of the organization with the `,_jsx(_components.code,{children:`admin`}),` role. Any other list is rejected with `,_jsx(_components.code,{children:`400`}),` (`,_jsx(_components.code,{children:`workspaces_inconsistent_with_role`}),`).`]})}),`\n`,_jsx(_components.p,{children:`The invitation belongs to the organization even when it names workspaces: it is listed and revoked through the organization’s invitations.`}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Returns the `,_jsx(_components.a,{href:`/platform-api/invitations/organization/invitation`,children:`Organization invitation`}),` object. The status code tells you which of the two things happened:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`201 Created`}),`: a new invitation was created.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`200 OK`}),`: an existing invitation was resent.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`The response includes `,_jsx(_components.code,{children:`user`}),`, the id of the pending user the invitation created. You can use it immediately as a grant or group target.`]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`11`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.nekt.ai/api/v1/organization/invitations/`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"email\": \"newcomer@example.com\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"organization_role\": \"member\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"workspaces\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"workspace\": \"3f6c2a1e-9b4d-4c7a-8e21-5d0b7a9c4e12\", \"role\": \"member\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`resending-and-role-changes`,children:`Resending and role changes`}),`\n`,_jsx(_components.p,{children:`Sending the same address again is safe and is how you chase someone who has not accepted. Nobody is duplicated: the existing invitation is resent with a fresh expiry, and the invitee’s existing groups and grants are untouched.`}),`\n`,_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`organization_role`}),` differs from the outstanding invitation, the resend is a role `,_jsx(_components.strong,{children:`change`}),`: it moves the person on both the invitation and their pending membership.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Moving an existing `,_jsx(_components.code,{children:`admin`}),` or `,_jsx(_components.code,{children:`owner`}),` invitee to another role requires an owner. This is the same ceiling that applies to changing the role of an accepted member.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`pending-users-and-pre-granted-invitations`,children:`Pending users and pre-granted invitations`}),`\n`,_jsx(_components.p,{children:`Because an invitation provisions the person right away, they exist as a pending member the moment the call succeeds:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Grant access before acceptance.`}),` In every workspace the invitee was placed in, a pending member is a normal target for every permission-assign endpoint, and can be `,_jsx(_components.a,{href:`/platform-api/permission-groups/add-members`,children:`added to a permission group`}),` with no separate flow.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Pending is not inactive.`}),` In the member list a pending member carries its own status; it is not the same as a deactivated user.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`They cannot log in until they accept.`}),` The invitation token is the only proof that the person controls the address.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Revoking is destructive.`}),` `,_jsx(_components.a,{href:`/platform-api/invitations/organization/revoke`,children:`Revoking`}),` removes the invitee’s workspaces, groups, and grants, not just the email.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`The invitation email expires after 7 days; the pre-granted access does not. An admin resends and nothing has to be re-granted.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`This endpoint requires an `,_jsx(_components.a,{href:`/platform-api/introduction#create-an-api-key`,children:`API key`}),` in the `,_jsx(_components.code,{children:`x-api-key`}),` header.`]}),`\n`,_jsxs(_components.p,{children:[`Only an organization `,_jsx(_components.strong,{children:`owner or admin`}),` can invite, and nobody can invite somebody to an organization role above their own. For an API key, that ceiling is read from the organization role of the user who created the key.`]}),`\n`,_jsxs(_components.p,{children:[`An API key belongs to one workspace, so through a key `,_jsx(_components.code,{children:`workspaces`}),` can only name the key’s own workspace. Any other workspace is rejected with `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`The address already belongs to an active member of the organization.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`email`}),` is missing or malformed.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`A workspace in `,_jsx(_components.code,{children:`workspaces`}),` is not an active workspace of your organization, is not reachable by the API key, or appears twice.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`workspaces_inconsistent_with_role`}),`: the request makes the invitee an owner or admin and `,_jsx(_components.code,{children:`workspaces`}),` does not list every workspace as `,_jsx(_components.code,{children:`admin`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`The caller is a member, or the request names an organization role above the caller’s own.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`The request changes the role of an existing `,_jsx(_components.code,{children:`admin`}),` or `,_jsx(_components.code,{children:`owner`}),` invitee and the caller is not an owner.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`The organization is on the Free plan, where only owners may be invited.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/platform-api/invitations/overview`,children:`Onboarding flow`}),`: invite, group, and grant before somebody accepts.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/platform-api/invitations/organization/bulk-invite`,children:`Bulk Invite Users`}),`: invite several people in one call.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/platform-api/invitations/workspace/invite`,children:`Invite to Workspace`}),`: invite someone into your current workspace as a workspace admin.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/platform-api/invitations/organization/list`,children:`List Invitations`}),`: what is still outstanding.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/platform-api/invitations/organization/revoke`,children:`Revoke an Invitation`}),`: and what it takes back.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Invite User","sidebarTitle":"Invite User","description":"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.","openapi":"POST /api/v1/organization/invitations/","href":"/platform-api/invitations/organization/invite"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request body","slug":"request-body","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]},{"title":"Resending and role changes","slug":"resending-and-role-changes","depth":2,"children":[]},{"title":"Pending users and pre-granted invitations","slug":"pending-users-and-pre-granted-invitations","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"v1_organization_invitations_create","description":"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.","tags":["v1"],"requestBody":"4521293c-5056-4e1e-b95b-92fa3abb20bd","security":["d862ebb8-27bc-465b-97f5-238b4b866df8"],"responses":{"201":"b38ee8ac-d920-4013-9781-95de109941ca"},"method":"post","type":"path","servers":["845afa24-3dc2-4af5-8f86-6e4995d5b2bf"],"path":"/api/v1/organization/invitations/","baseUrlOptions":["https://api.nekt.ai"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"An invitation as `organization/invitations/` answers it: `invitations/`'s fields, plus the user\nit created (pending in the organization until they accept) and the workspace it was issued in\n(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). `created_by`,\n`user` and `workspace` are ids, each expandable. `organization_role` is the role in the organization\nthe invitation grants, `invitations/`'s `role`.","properties":{"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"last_name","typeLabel":"string"},"organization_role":{"type":"string","description":"The invitee's role in the organization. Defaults to `member`. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.\n\n* `owner` - Owner\n* `admin` - Admin\n* `member` - Member","default":"member","enum":["owner","admin","member"],"uniqueKey":"organization_role","typeLabel":"enum\u003cstring>"},"functional_area":{"oneOf":[{"type":"string","description":"* `data_analytics` - Data \u0026 Analytics\n* `sales` - Sales\n* `customer_support` - Customer Support\n* `operations` - Operations\n* `marketing` - Marketing\n* `finance` - Finance\n* `product_development` - Product Development\n* `growth` - Growth\n* `executive_leadership` - Executive Leadership\n* `other` - Other","enum":["data_analytics","sales","customer_support","operations","marketing","finance","product_development","growth","executive_leadership","other"],"uniqueKey":"functional_area.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"functional_area.oneOf.1","typeLabel":"enum\u003cstring>"},{"enum":[null],"uniqueKey":"functional_area.oneOf.2","typeLabel":"any"},{"type":"null","uniqueKey":"functional_area.oneOf.3","typeLabel":"null"}],"uniqueKey":"functional_area","typeLabel":"enum\u003cstring> · enum\u003cstring> · any · null"},"other_functional_area":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"other_functional_area.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"other_functional_area.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_functional_area","typeLabel":"string | null"},"workspaces":{"type":"array","items":{"type":"object","description":"One workspace an organization invitation places its invitee in, with their role there.","properties":{"workspace":{"type":"string","format":"uuid","description":"A workspace of your organization.","isRequired":true,"uniqueKey":"workspaces.items.[INDEX].workspace","typeLabel":"string\u003cuuid>"},"role":{"type":"string","description":"The invitee's role in `workspace`.\n\n* `admin` - Admin\n* `member` - Member","enum":["admin","member"],"isRequired":true,"uniqueKey":"workspaces.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["role","workspace"],"uniqueKey":"workspaces.items.[INDEX]","typeLabel":"object"},"writeOnly":true,"description":"Workspaces to place the invitee in right away, each with their role there; the invitation still belongs to the organization. An owner or admin is an admin of every workspace: omit `workspaces` for them, or list every workspace as admin. No workspace twice.","uniqueKey":"workspaces","typeLabel":"object[]"}},"required":["accepted_at","created_at","created_by","email","expires_at","id","revoked_at","sent_at","user","workspace"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"jsmith@example.com","first_name":"\u003cstring>","last_name":"\u003cstring>","organization_role":"member","other_functional_area":"\u003cstring>","workspaces":[{"workspace":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"An invitation as `organization/invitations/` answers it: `invitations/`'s fields, plus the user\nit created (pending in the organization until they accept) and the workspace it was issued in\n(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). `created_by`,\n`user` and `workspace` are ids, each expandable. `organization_role` is the role in the organization\nthe invitation grants, `invitations/`'s `role`.","properties":{"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"last_name","typeLabel":"string"},"organization_role":{"type":"string","description":"The invitee's role in the organization. Defaults to `member`. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.\n\n* `owner` - Owner\n* `admin` - Admin\n* `member` - Member","default":"member","enum":["owner","admin","member"],"uniqueKey":"organization_role","typeLabel":"enum\u003cstring>"},"functional_area":{"oneOf":[{"type":"string","description":"* `data_analytics` - Data \u0026 Analytics\n* `sales` - Sales\n* `customer_support` - Customer Support\n* `operations` - Operations\n* `marketing` - Marketing\n* `finance` - Finance\n* `product_development` - Product Development\n* `growth` - Growth\n* `executive_leadership` - Executive Leadership\n* `other` - Other","enum":["data_analytics","sales","customer_support","operations","marketing","finance","product_development","growth","executive_leadership","other"],"uniqueKey":"functional_area.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"functional_area.oneOf.1","typeLabel":"enum\u003cstring>"},{"enum":[null],"uniqueKey":"functional_area.oneOf.2","typeLabel":"any"},{"type":"null","uniqueKey":"functional_area.oneOf.3","typeLabel":"null"}],"uniqueKey":"functional_area","typeLabel":"enum\u003cstring> · enum\u003cstring> · any · null"},"other_functional_area":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"other_functional_area.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"other_functional_area.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_functional_area","typeLabel":"string | null"},"workspaces":{"type":"array","items":{"type":"object","description":"One workspace an organization invitation places its invitee in, with their role there.","properties":{"workspace":{"type":"string","format":"uuid","description":"A workspace of your organization.","isRequired":true,"uniqueKey":"workspaces.items.[INDEX].workspace","typeLabel":"string\u003cuuid>"},"role":{"type":"string","description":"The invitee's role in `workspace`.\n\n* `admin` - Admin\n* `member` - Member","enum":["admin","member"],"isRequired":true,"uniqueKey":"workspaces.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["role","workspace"],"uniqueKey":"workspaces.items.[INDEX]","typeLabel":"object"},"writeOnly":true,"description":"Workspaces to place the invitee in right away, each with their role there; the invitation still belongs to the organization. An owner or admin is an admin of every workspace: omit `workspaces` for them, or list every workspace as admin. No workspace twice.","uniqueKey":"workspaces","typeLabel":"object[]"}},"required":["accepted_at","created_at","created_by","email","expires_at","id","revoked_at","sent_at","user","workspace"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"jsmith@example.com","first_name":"\u003cstring>","last_name":"\u003cstring>","organization_role":"member","other_functional_area":"\u003cstring>","workspaces":[{"workspace":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","description":"An invitation as `organization/invitations/` answers it: `invitations/`'s fields, plus the user\nit created (pending in the organization until they accept) and the workspace it was issued in\n(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). `created_by`,\n`user` and `workspace` are ids, each expandable. `organization_role` is the role in the organization\nthe invitation grants, `invitations/`'s `role`.","properties":{"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"last_name","typeLabel":"string"},"organization_role":{"type":"string","description":"The invitee's role in the organization. Defaults to `member`. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.\n\n* `owner` - Owner\n* `admin` - Admin\n* `member` - Member","default":"member","enum":["owner","admin","member"],"uniqueKey":"organization_role","typeLabel":"enum\u003cstring>"},"functional_area":{"oneOf":[{"type":"string","description":"* `data_analytics` - Data \u0026 Analytics\n* `sales` - Sales\n* `customer_support` - Customer Support\n* `operations` - Operations\n* `marketing` - Marketing\n* `finance` - Finance\n* `product_development` - Product Development\n* `growth` - Growth\n* `executive_leadership` - Executive Leadership\n* `other` - Other","enum":["data_analytics","sales","customer_support","operations","marketing","finance","product_development","growth","executive_leadership","other"],"uniqueKey":"functional_area.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"functional_area.oneOf.1","typeLabel":"enum\u003cstring>"},{"enum":[null],"uniqueKey":"functional_area.oneOf.2","typeLabel":"any"},{"type":"null","uniqueKey":"functional_area.oneOf.3","typeLabel":"null"}],"uniqueKey":"functional_area","typeLabel":"enum\u003cstring> · enum\u003cstring> · any · null"},"other_functional_area":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"other_functional_area.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"other_functional_area.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_functional_area","typeLabel":"string | null"},"workspaces":{"type":"array","items":{"type":"object","description":"One workspace an organization invitation places its invitee in, with their role there.","properties":{"workspace":{"type":"string","format":"uuid","description":"A workspace of your organization.","isRequired":true,"uniqueKey":"workspaces.items.[INDEX].workspace","typeLabel":"string\u003cuuid>"},"role":{"type":"string","description":"The invitee's role in `workspace`.\n\n* `admin` - Admin\n* `member` - Member","enum":["admin","member"],"isRequired":true,"uniqueKey":"workspaces.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["role","workspace"],"uniqueKey":"workspaces.items.[INDEX]","typeLabel":"object"},"writeOnly":true,"description":"Workspaces to place the invitee in right away, each with their role there; the invitation still belongs to the organization. An owner or admin is an admin of every workspace: omit `workspaces` for them, or list every workspace as admin. No workspace twice.","uniqueKey":"workspaces","typeLabel":"object[]"}},"required":["accepted_at","created_at","created_by","email","expires_at","id","revoked_at","sent_at","user","workspace"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"jsmith@example.com","first_name":"\u003cstring>","last_name":"\u003cstring>","organization_role":"member","other_functional_area":"\u003cstring>","workspaces":[{"workspace":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"b38ee8ac-d920-4013-9781-95de109941ca":{"content":{"application/json":{"schema":{"type":"object","description":"An invitation as `organization/invitations/` answers it: `invitations/`'s fields, plus the user\nit created (pending in the organization until they accept) and the workspace it was issued in\n(a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). `created_by`,\n`user` and `workspace` are ids, each expandable. `organization_role` is the role in the organization\nthe invitation grants, `invitations/`'s `role`.","properties":{"id":{"type":"string","format":"uuid","readOnly":true,"isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"sent_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"sent_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"accepted_at":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"accepted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"accepted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accepted_at","typeLabel":"string\u003cdate-time> | null"},"revoked_at":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"revoked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"revoked_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"revoked_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"integer","readOnly":true,"description":"The user who sent the invitation. (Expandable)","isRequired":true,"uniqueKey":"created_by","typeLabel":"integer"},"user":{"oneOf":[{"type":"integer","readOnly":true,"description":"The user the invitation created, pending in the organization until they accept. (Expandable)","isRequired":true,"uniqueKey":"user.oneOf.0","typeLabel":"integer"},{"type":"null","readOnly":true,"description":"The user the invitation created, pending in the organization until they accept. (Expandable)","isRequired":true,"uniqueKey":"user.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"user","typeLabel":"integer | null"},"workspace":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"The workspace the invitation was issued in; null for an organization invitation. (Expandable)","isRequired":true,"uniqueKey":"workspace.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"The workspace the invitation was issued in; null for an organization invitation. (Expandable)","isRequired":true,"uniqueKey":"workspace.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"workspace","typeLabel":"string\u003cuuid> | null"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"last_name","typeLabel":"string"},"organization_role":{"type":"string","description":"The invitee's role in the organization. Defaults to `member`. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.\n\n* `owner` - Owner\n* `admin` - Admin\n* `member` - Member","default":"member","enum":["owner","admin","member"],"uniqueKey":"organization_role","typeLabel":"enum\u003cstring>"},"functional_area":{"oneOf":[{"type":"string","description":"* `data_analytics` - Data \u0026 Analytics\n* `sales` - Sales\n* `customer_support` - Customer Support\n* `operations` - Operations\n* `marketing` - Marketing\n* `finance` - Finance\n* `product_development` - Product Development\n* `growth` - Growth\n* `executive_leadership` - Executive Leadership\n* `other` - Other","enum":["data_analytics","sales","customer_support","operations","marketing","finance","product_development","growth","executive_leadership","other"],"uniqueKey":"functional_area.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"functional_area.oneOf.1","typeLabel":"enum\u003cstring>"},{"enum":[null],"uniqueKey":"functional_area.oneOf.2","typeLabel":"any"},{"type":"null","uniqueKey":"functional_area.oneOf.3","typeLabel":"null"}],"uniqueKey":"functional_area","typeLabel":"enum\u003cstring> · enum\u003cstring> · any · null"},"other_functional_area":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"other_functional_area.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"other_functional_area.oneOf.1","typeLabel":"null"}],"uniqueKey":"other_functional_area","typeLabel":"string | null"}},"required":["accepted_at","created_at","created_by","email","expires_at","id","revoked_at","sent_at","user","workspace"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","email":"jsmith@example.com","sent_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","accepted_at":"2023-11-07T05:31:56Z","revoked_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","created_by":123,"user":123,"workspace":"3c90c3cc-0d44-4b50-8888-8dd25736052a","first_name":"\u003cstring>","last_name":"\u003cstring>","organization_role":"member","functional_area":"data_analytics","other_functional_area":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"d862ebb8-27bc-465b-97f5-238b4b866df8":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key authentication. Format: 'x-api-key: api_key'","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"845afa24-3dc2-4af5-8f86-6e4995d5b2bf":{"url":"https://api.nekt.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key authentication. Format: 'x-api-key: api_key'","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API Key authentication. Format: 'x-api-key: api_key'","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.nekt.ai/api/schema/"},"subdomain":"nekt","siteName":"Nekt","title":"Invite User - Nekt","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T12:58:58.349Z","originalFileLocation":"platform-api/invitations/organization/invite.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=\"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nekt\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_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/nekt/vtuzSdYqWUIGYPQe/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Invite User - Nekt\">\u003cmeta data-mint-head property=\"og:description\" content=\"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nekt\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nekt.com/platform-api/invitations/organization/invite\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nekt.mintlify.site/_mintlify/api/og/v2?division=Organization+invitations\u0026amp;title=Invite+User\u0026amp;description=Invite+one+person+to+your+organization%2C+optionally+placing+them+in+workspaces%2C+or+resend+the+invitation+they+already+have.\u0026amp;theme=ab0eecb27443f99b68604474\u0026amp;signature=5ffd8644b2938dc578ca9720062a55855cf8e6599201c7669d4bfe35a6b37b6a\">\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=\"Invite User - Nekt\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nekt.mintlify.site/_mintlify/api/og/v2?division=Organization+invitations\u0026amp;title=Invite+User\u0026amp;description=Invite+one+person+to+your+organization%2C+optionally+placing+them+in+workspaces%2C+or+resend+the+invitation+they+already+have.\u0026amp;theme=ab0eecb27443f99b68604474\u0026amp;signature=5ffd8644b2938dc578ca9720062a55855cf8e6599201c7669d4bfe35a6b37b6a\">\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/nekt/vtuzSdYqWUIGYPQe/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nekt\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#097860\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nekt.com/platform-api/invitations/organization/invite\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-api/invitations/organization/invite.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nekt.com/#organization\",\"name\":\"Nekt\",\"url\":\"https://docs.nekt.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nekt/fAFtC-RZLnUKCv7c/assets/logo/light.svg?fit=max\u0026auto=format\u0026n=fAFtC-RZLnUKCv7c\u0026q=85\u0026s=cba8701f886607d770a7510c525d81b7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nekt.com#website\",\"name\":\"Nekt\",\"url\":\"https://docs.nekt.com\",\"publisher\":{\"@id\":\"https://docs.nekt.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nekt.com/platform-api/invitations/organization/invite#webpage\",\"url\":\"https://docs.nekt.com/platform-api/invitations/organization/invite\",\"name\":\"Invite User\",\"description\":\"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\",\"dateModified\":\"2026-11-18T12:58:58.349Z\",\"isPartOf\":{\"@id\":\"https://docs.nekt.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nekt.com/platform-api/invitations/organization/invite#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nekt.com/platform-api/invitations/organization/invite#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invitations\",\"item\":\"https://docs.nekt.com/platform-api/invitations/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Organization invitations\",\"item\":\"https://docs.nekt.com/platform-api/invitations/organization/invitation\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Invite User\",\"item\":\"https://docs.nekt.com/platform-api/invitations/organization/invite\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nekt.com/platform-api/invitations/organization/invite#apireference\",\"headline\":\"Invite User\",\"name\":\"Invite User\",\"description\":\"Invite one person to your organization, optionally placing them in workspaces, or resend the invitation they already have.\",\"url\":\"https://docs.nekt.com/platform-api/invitations/organization/invite\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nekt.com/platform-api/invitations/organization/invite#webpage\"},\"dateModified\":\"2026-11-18T12:58:58.349Z\",\"publisher\":{\"@id\":\"https://docs.nekt.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nekt.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nekt\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nekt\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform-api/invitations/organization/invite.md","siteName":"Nekt","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/what-is-nekt"}]},{"anchor":"Platform API","icon":"square-terminal","groups":[{"group":"Platform API","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/platform-api/introduction"},{"title":"Expanding Responses","sidebarTitle":"Expanding Responses","href":"/platform-api/expanding-responses"}]},{"group":"Activities","pages":[{"title":"Activity object","href":"/platform-api/activities/activity"},{"title":"List Activities","openapi":"GET /api/v1/activities/","href":"/platform-api/activities/list"}]},{"group":"Connectors","pages":[{"title":"Connector object","href":"/platform-api/connectors/connector"},{"title":"Connector version object","href":"/platform-api/connectors/version"},{"title":"List Source Connectors","openapi":"GET /api/v1/sources/connectors/","href":"/platform-api/connectors/source"},{"title":"List Destination Connectors","openapi":"GET /api/v1/destinations/connectors/","href":"/platform-api/connectors/destination"},{"title":"List MCP Connectors","openapi":"GET /api/v1/live-connectors/","href":"/platform-api/connectors/mcp"}]},{"group":"Sources","pages":[{"title":"Source object","href":"/platform-api/sources/source"},{"title":"List Sources","openapi":"GET /api/v1/sources/","href":"/platform-api/sources/list"},{"title":"Get Source","openapi":"GET /api/v1/sources/{slug}/","href":"/platform-api/sources/details"},{"title":"Create Source","sidebarTitle":"Create Source","openapi":"POST /api/v1/sources/","href":"/platform-api/sources/create"},{"title":"Configure a source with a setup link","sidebarTitle":"Setup link \u0026 callback","href":"/platform-api/sources/setup-link"},{"title":"Create Setup Token","openapi":"POST /api/v1/sources/{source_slug}/setup-tokens/","href":"/platform-api/sources/setup-tokens/create"},{"title":"List Setup Tokens","openapi":"GET /api/v1/sources/{source_slug}/setup-tokens/","href":"/platform-api/sources/setup-tokens/list"},{"title":"Delete Setup Token","openapi":"DELETE /api/v1/sources/{source_slug}/setup-tokens/{id}/","href":"/platform-api/sources/setup-tokens/delete"},{"title":"Validate Connector","openapi":"POST /api/v1/sources/{slug}/revalidate/","href":"/platform-api/sources/revalidate"},{"title":"Update Source","openapi":"PATCH /api/v1/sources/{slug}/","href":"/platform-api/sources/update"},{"title":"Delete Source","sidebarTitle":"Delete Source","openapi":"DELETE /api/v1/sources/{slug}/","href":"/platform-api/sources/delete"},{"title":"Bulk Delete Sources","sidebarTitle":"Bulk Delete Sources","openapi":"POST /api/v1/sources/bulk-delete/","href":"/platform-api/sources/bulk-delete"},{"title":"Trigger Source","openapi":"POST /api/v1/sources/{slug}/trigger/","href":"/platform-api/sources/trigger"},{"title":"List Source Triggers","openapi":"GET /api/v1/sources/{source_slug}/triggers/","href":"/platform-api/sources/triggers/list"},{"title":"Get Source Trigger","openapi":"GET /api/v1/sources/{source_slug}/triggers/{id}/","href":"/platform-api/sources/triggers/details"}]},{"group":"MCP connections","pages":[{"title":"MCP Connection object","href":"/platform-api/mcp-connections/mcp-connection"},{"title":"List MCP Connections","openapi":"GET /api/v1/live-connections/","href":"/platform-api/mcp-connections/list"},{"title":"MCP Connection Details","openapi":"GET /api/v1/live-connections/{slug}/","href":"/platform-api/mcp-connections/details"},{"title":"Create MCP Connection","openapi":"POST /api/v1/live-connections/","href":"/platform-api/mcp-connections/create"},{"title":"Connect an MCP with a setup link","sidebarTitle":"Setup link \u0026 callback","href":"/platform-api/mcp-connections/setup-link"},{"title":"Create Setup Token","openapi":"POST /api/v1/live-connections/{live_connection_slug}/setup-tokens/","href":"/platform-api/mcp-connections/setup-tokens/create"},{"title":"List Setup Tokens","openapi":"GET /api/v1/live-connections/{live_connection_slug}/setup-tokens/","href":"/platform-api/mcp-connections/setup-tokens/list"},{"title":"Delete Setup Token","openapi":"DELETE /api/v1/live-connections/{live_connection_slug}/setup-tokens/{id}/","href":"/platform-api/mcp-connections/setup-tokens/delete"},{"title":"List Connection Tools","openapi":"GET /api/v1/live-connections/{slug}/tools/","href":"/platform-api/mcp-connections/tools"},{"title":"Update Connection Tools","openapi":"PATCH /api/v1/live-connections/{slug}/tools/","href":"/platform-api/mcp-connections/update-tools"},{"title":"Update MCP Connection","openapi":"PATCH /api/v1/live-connections/{slug}/","href":"/platform-api/mcp-connections/update"},{"title":"Archive MCP Connection","openapi":"POST /api/v1/live-connections/{slug}/archive/","href":"/platform-api/mcp-connections/archive"},{"title":"Unarchive MCP Connection","openapi":"POST /api/v1/live-connections/{slug}/unarchive/","href":"/platform-api/mcp-connections/unarchive"},{"title":"Delete MCP Connection","openapi":"DELETE /api/v1/live-connections/{slug}/","href":"/platform-api/mcp-connections/delete"}]},{"group":"Connector validations","pages":[{"title":"Get Connector Validation","openapi":"GET /api/v1/connector-validations/{id}/","href":"/platform-api/connector-validations/details"},{"title":"Get Connector Validation Logs","openapi":"GET /api/v1/connector-validations/{id}/logs/","href":"/platform-api/connector-validations/logs"}]},{"group":"Transformations","pages":[{"title":"Transformation object","href":"/platform-api/transformations/transformation"},{"title":"Get Transformations","openapi":"GET /api/v1/transformations/","href":"/platform-api/transformations/list"},{"title":"Get Transformation","openapi":"GET /api/v1/transformations/{slug}/","href":"/platform-api/transformations/details"},{"title":"Update Transformation","openapi":"PATCH /api/v1/transformations/{slug}/","href":"/platform-api/transformations/update"},{"title":"Delete Transformation","sidebarTitle":"Delete Transformation","openapi":"DELETE /api/v1/transformations/{slug}/","href":"/platform-api/transformations/delete"},{"title":"Bulk Delete Transformations","sidebarTitle":"Bulk Delete Transformations","openapi":"POST /api/v1/transformations/bulk-delete/","href":"/platform-api/transformations/bulk-delete"},{"title":"Trigger Transformation","openapi":"POST /api/v1/transformations/{slug}/trigger/","href":"/platform-api/transformations/trigger"}]},{"group":"Destinations","pages":[{"title":"Destination object","href":"/platform-api/destinations/destination"},{"title":"List Destinations","openapi":"GET /api/v1/destinations/","href":"/platform-api/destinations/list"},{"title":"Get Destination","openapi":"GET /api/v1/destinations/{slug}/","href":"/platform-api/destinations/details"},{"title":"Update Destination","openapi":"PATCH /api/v1/destinations/{slug}/","href":"/platform-api/destinations/update"},{"title":"Delete Destination","sidebarTitle":"Delete Destination","openapi":"DELETE /api/v1/destinations/{slug}/","href":"/platform-api/destinations/delete"},{"title":"Bulk Delete Destinations","sidebarTitle":"Bulk Delete Destinations","openapi":"POST /api/v1/destinations/bulk-delete/","href":"/platform-api/destinations/bulk-delete"},{"title":"Trigger Destination","openapi":"POST /api/v1/destinations/{slug}/trigger/","href":"/platform-api/destinations/trigger"},{"title":"List Destination Triggers","openapi":"GET /api/v1/destinations/{destination_slug}/triggers/","href":"/platform-api/destinations/triggers/list"},{"title":"Get Destination Trigger","openapi":"GET /api/v1/destinations/{destination_slug}/triggers/{id}/","href":"/platform-api/destinations/triggers/details"}]},{"group":"Runs","pages":[{"title":"Run object","href":"/platform-api/runs/run"},{"title":"Get Runs","openapi":"GET /api/v1/runs/","href":"/platform-api/runs/list"},{"title":"Get Run","openapi":"GET /api/v1/runs/{id}/","href":"/platform-api/runs/details"},{"title":"Get Run Logs","openapi":"GET /api/v1/runs/{id}/logs/","href":"/platform-api/runs/logs"},{"title":"Cancel Run","openapi":"POST /api/v1/runs/{id}/cancel/","href":"/platform-api/runs/cancel"}]},{"group":"Catalog","pages":[{"title":"Layer object","href":"/platform-api/catalog/layer"},{"title":"List Layers","openapi":"GET /api/v1/layers/","href":"/platform-api/catalog/list-layers"},{"title":"Update Layer","openapi":"PATCH /api/v1/layers/{slug}/","href":"/platform-api/catalog/update-layer"},{"title":"Table object","href":"/platform-api/catalog/table"},{"title":"Update Table","openapi":"PATCH /api/v1/tables/{id}/","href":"/platform-api/catalog/update-table"},{"title":"Update Field","openapi":"PATCH /api/v1/tables/{table_pk}/fields/{name}/","href":"/platform-api/catalog/update-field"},{"title":"Volume object","href":"/platform-api/catalog/volume"},{"title":"Folder object","href":"/platform-api/catalog/folder"}]},{"group":"Semantic Layer","pages":[{"title":"Semantic Layer document object","sidebarTitle":"Document object","href":"/platform-api/semantic-layer/document"},{"title":"List Semantic Layer Documents","sidebarTitle":"List documents","openapi":"GET /api/v1/semantic-layer/documents/","href":"/platform-api/semantic-layer/list"},{"title":"Retrieve Semantic Layer Document","sidebarTitle":"Retrieve document","openapi":"GET /api/v1/semantic-layer/documents/{id}/","href":"/platform-api/semantic-layer/retrieve"},{"title":"Create Semantic Layer Document","sidebarTitle":"Create document","openapi":"POST /api/v1/semantic-layer/documents/","href":"/platform-api/semantic-layer/create"},{"title":"Update Semantic Layer Document","sidebarTitle":"Update document","openapi":"PATCH /api/v1/semantic-layer/documents/{id}/","href":"/platform-api/semantic-layer/update"},{"title":"Create Semantic Layer Folder","sidebarTitle":"Create folder","openapi":"POST /api/v1/semantic-layer/folders/","href":"/platform-api/semantic-layer/create-folder"},{"title":"Update Semantic Layer Folder","sidebarTitle":"Update folder","openapi":"PATCH /api/v1/semantic-layer/folders/{id}/","href":"/platform-api/semantic-layer/update-folder"},{"title":"Delete Semantic Layer Folder","sidebarTitle":"Delete folder","openapi":"DELETE /api/v1/semantic-layer/folders/{id}/","href":"/platform-api/semantic-layer/delete-folder"},{"title":"Check Semantic Layer Folder Name","sidebarTitle":"Check folder name","openapi":"POST /api/v1/semantic-layer/folders/check-name-availability/","href":"/platform-api/semantic-layer/check-folder-name"}]},{"group":"MCP Tokens","pages":[{"title":"MCP token object","sidebarTitle":"MCP token object","href":"/platform-api/mcp-tokens/mcp-token"},{"title":"List MCP Tokens","sidebarTitle":"List tokens","openapi":"GET /api/v1/mcp/tokens/","href":"/platform-api/mcp-tokens/list"},{"title":"Create MCP Token","sidebarTitle":"Create token","openapi":"POST /api/v1/mcp/tokens/","href":"/platform-api/mcp-tokens/create"},{"title":"Update MCP Token","sidebarTitle":"Update token","openapi":"PATCH /api/v1/mcp/tokens/{id}/","href":"/platform-api/mcp-tokens/update"},{"title":"Rotate MCP Token","sidebarTitle":"Rotate token","openapi":"POST /api/v1/mcp/tokens/{id}/rotate-credentials/","href":"/platform-api/mcp-tokens/rotate"}]},{"group":"Users","pages":[{"title":"User object","href":"/platform-api/users/user"}]},{"group":"Invitations","pages":[{"title":"Onboarding flow","sidebarTitle":"Overview","href":"/platform-api/invitations/overview"},{"group":"Organization invitations","pages":[{"title":"Organization invitation object","sidebarTitle":"Organization invitation object","href":"/platform-api/invitations/organization/invitation"},{"title":"List Invitations","sidebarTitle":"List Invitations","description":"The organization's invitations still waiting on a reply.","openapi":"GET /api/v1/organization/invitations/","href":"/platform-api/invitations/organization/list"},{"title":"Invite User","sidebarTitle":"Invite User","openapi":"POST /api/v1/organization/invitations/","href":"/platform-api/invitations/organization/invite"},{"title":"Bulk Invite Users","sidebarTitle":"Bulk Invite Users","description":"Invite several people to your organization, and its workspaces, in one request.","openapi":"POST /api/v1/organization/invitations/bulk-invite/","href":"/platform-api/invitations/organization/bulk-invite"},{"title":"Revoke an Invitation","sidebarTitle":"Revoke an Invitation","openapi":"DELETE /api/v1/organization/invitations/{token}/","href":"/platform-api/invitations/organization/revoke"}]},{"group":"Workspace invitations","pages":[{"title":"Workspace invitation object","sidebarTitle":"Workspace invitation object","href":"/platform-api/invitations/workspace/invitation"},{"title":"List Workspace Invitations","sidebarTitle":"List Workspace Invitations","openapi":"GET /api/v1/workspace/invitations/","href":"/platform-api/invitations/workspace/list"},{"title":"Invite to Workspace","sidebarTitle":"Invite to Workspace","openapi":"POST /api/v1/workspace/invitations/","href":"/platform-api/invitations/workspace/invite"},{"title":"Bulk Invite to Workspace","sidebarTitle":"Bulk Invite to Workspace","openapi":"POST /api/v1/workspace/invitations/bulk-invite/","href":"/platform-api/invitations/workspace/bulk-invite"},{"title":"Revoke a Workspace Invitation","sidebarTitle":"Revoke a Workspace Invitation","openapi":"DELETE /api/v1/workspace/invitations/{id}/","href":"/platform-api/invitations/workspace/revoke"}]},{"group":"Legacy","pages":[{"title":"Invitation object (legacy)","sidebarTitle":"Invitation object","href":"/platform-api/invitations/legacy/invitation"},{"title":"List Invitations (legacy)","sidebarTitle":"List Invitations","openapi":"GET /api/v1/invitations/","href":"/platform-api/invitations/legacy/list"},{"title":"Invite User (legacy)","sidebarTitle":"Invite User","openapi":"POST /api/v1/invitations/","href":"/platform-api/invitations/legacy/invite"},{"title":"Bulk Invite Users (legacy)","sidebarTitle":"Bulk Invite Users","openapi":"POST /api/v1/invitations/bulk-invite/","href":"/platform-api/invitations/legacy/bulk-invite"},{"title":"Revoke an Invitation (legacy)","sidebarTitle":"Revoke an Invitation","openapi":"DELETE /api/v1/invitations/{token}/","href":"/platform-api/invitations/legacy/revoke"}]}]},{"group":"Permissions","pages":[{"title":"Permissions flow","sidebarTitle":"Overview","href":"/platform-api/permissions/overview"},{"group":"Permission groups","pages":[{"title":"Permission groups","sidebarTitle":"Overview","href":"/platform-api/permission-groups/overview"},{"title":"Permission group object","href":"/platform-api/permission-groups/permission-group"},{"title":"List Permission Groups","sidebarTitle":"List Groups","openapi":"GET /api/v1/organization/permission-groups/","href":"/platform-api/permission-groups/list"},{"title":"Retrieve a Permission Group","sidebarTitle":"Retrieve a Group","openapi":"GET /api/v1/organization/permission-groups/{id}/","href":"/platform-api/permission-groups/details"},{"title":"Create a Permission Group","sidebarTitle":"Create a Group","openapi":"POST /api/v1/organization/permission-groups/","href":"/platform-api/permission-groups/create"},{"title":"Update a Permission Group","sidebarTitle":"Update a Group","openapi":"PATCH /api/v1/organization/permission-groups/{id}/","href":"/platform-api/permission-groups/update"},{"title":"Delete a Permission Group","sidebarTitle":"Delete a Group","openapi":"DELETE /api/v1/organization/permission-groups/{id}/","href":"/platform-api/permission-groups/delete"},{"title":"List Group Members","sidebarTitle":"List Members","openapi":"GET /api/v1/organization/permission-groups/{permission_group_pk}/users/","href":"/platform-api/permission-groups/members"},{"title":"Add Group Members","sidebarTitle":"Add Members","openapi":"POST /api/v1/organization/permission-groups/{permission_group_pk}/users/","href":"/platform-api/permission-groups/add-members"},{"title":"Remove Group Members","sidebarTitle":"Remove Members","openapi":"DELETE /api/v1/organization/permission-groups/{permission_group_pk}/users/","href":"/platform-api/permission-groups/remove-members"}]},{"group":"Catalog","pages":[{"title":"Permission object","href":"/platform-api/permissions/catalog/permission"},{"title":"List Permission Recipients","sidebarTitle":"List Recipients","openapi":"GET /api/v1/permission-recipients/","href":"/platform-api/permissions/catalog/recipients"},{"title":"List Permissions","openapi":"GET /api/v1/permissions/","href":"/platform-api/permissions/catalog/list"},{"title":"Retrieve Permission","openapi":"GET /api/v1/permissions/{id}/","href":"/platform-api/permissions/catalog/details"},{"title":"Assign Permissions","sidebarTitle":"Assign Permissions","openapi":"POST /api/v1/permissions/","href":"/platform-api/permissions/catalog/assign"},{"title":"Update Permission","sidebarTitle":"Update Permission","openapi":"PATCH /api/v1/permissions/{id}/","href":"/platform-api/permissions/catalog/update"},{"title":"Revoke Permission","sidebarTitle":"Revoke Permission","openapi":"DELETE /api/v1/permissions/{id}/","href":"/platform-api/permissions/catalog/revoke"}]},{"group":"Secrets \u0026 live connections","pages":[{"title":"Object permission object","href":"/platform-api/permissions/objects/object-permission"},{"title":"List Object Permission Recipients","sidebarTitle":"List Recipients","openapi":"GET /api/v1/organization/object-permission-recipients/","href":"/platform-api/permissions/objects/recipients"},{"title":"List Object Permissions","sidebarTitle":"List Object Permissions","openapi":"GET /api/v1/organization/object-permissions/","href":"/platform-api/permissions/objects/list"},{"title":"Retrieve Object Permission","openapi":"GET /api/v1/organization/object-permissions/{id}/","href":"/platform-api/permissions/objects/details"},{"title":"Assign Object Permissions","sidebarTitle":"Assign Object Permissions","openapi":"POST /api/v1/organization/object-permissions/","href":"/platform-api/permissions/objects/assign"},{"title":"Update Object Permission","sidebarTitle":"Update Object Permission","openapi":"PATCH /api/v1/organization/object-permissions/{id}/","href":"/platform-api/permissions/objects/update"},{"title":"Revoke Object Permission","sidebarTitle":"Revoke Object Permission","openapi":"DELETE /api/v1/organization/object-permissions/{id}/","href":"/platform-api/permissions/objects/revoke"}]},{"group":"Semantic Layer","pages":[{"title":"Semantic Layer permission object","href":"/platform-api/permissions/semantic-layer/semantic-layer-permission"},{"title":"Read the Semantic Layer","sidebarTitle":"Read resources","openapi":"GET /api/v1/semantic-layer/catalog/","href":"/platform-api/permissions/semantic-layer/resources"},{"title":"List Semantic Layer Folders","sidebarTitle":"List Folders","openapi":"GET /api/v1/semantic-layer/folders/","href":"/platform-api/permissions/semantic-layer/list-folders"},{"title":"List Semantic Layer Permission Recipients","sidebarTitle":"List Recipients","openapi":"GET /api/v1/semantic-layer/permission-recipients/","href":"/platform-api/permissions/semantic-layer/recipients"},{"title":"List Semantic Layer Permissions","sidebarTitle":"List Permissions","openapi":"GET /api/v1/semantic-layer/permissions/","href":"/platform-api/permissions/semantic-layer/list"},{"title":"Retrieve Semantic Layer Permission","sidebarTitle":"Retrieve Permission","openapi":"GET /api/v1/semantic-layer/permissions/{id}/","href":"/platform-api/permissions/semantic-layer/details"},{"title":"Assign Semantic Layer Permissions","sidebarTitle":"Assign Permissions","openapi":"POST /api/v1/semantic-layer/permissions/","href":"/platform-api/permissions/semantic-layer/assign"},{"title":"Update Semantic Layer Permission","sidebarTitle":"Update Permission","openapi":"PATCH /api/v1/semantic-layer/permissions/{id}/","href":"/platform-api/permissions/semantic-layer/update"},{"title":"Revoke Semantic Layer Permission","sidebarTitle":"Revoke Permission","openapi":"DELETE /api/v1/semantic-layer/permissions/{id}/","href":"/platform-api/permissions/semantic-layer/revoke"}]}]},{"group":"Visualizations","pages":[{"title":"Visualization object","href":"/platform-api/visualizations/visualization"}]},{"group":"Tags","pages":[{"title":"Tag object","href":"/platform-api/tags/tag"},{"title":"List Tags","openapi":"GET /api/v1/tags/","href":"/platform-api/tags/list"},{"title":"Get Tag","openapi":"GET /api/v1/tags/{id}/","href":"/platform-api/tags/details"},{"title":"Create Tag","openapi":"POST /api/v1/tags/","href":"/platform-api/tags/create"},{"title":"Update Tag","openapi":"PATCH /api/v1/tags/{id}/","href":"/platform-api/tags/update"},{"title":"Attach Tags","sidebarTitle":"Attach Tags","openapi":"POST /api/v1/tags/attach/","href":"/platform-api/tags/attach"},{"title":"Detach Tags","sidebarTitle":"Detach Tags","openapi":"POST /api/v1/tags/detach/","href":"/platform-api/tags/detach"}]},{"group":"API Tokens","pages":[{"title":"API token object","href":"/platform-api/api-token/token"}]},{"group":"Audit Logs","pages":[{"title":"Token access log object","href":"/platform-api/token-access-logs/token-access-log"},{"title":"List Token Access Logs","openapi":"GET /api/v1/token-access-logs/","href":"/platform-api/token-access-logs/list"},{"title":"Get Token Access Log","openapi":"GET /api/v1/token-access-logs/{id}/","href":"/platform-api/token-access-logs/details"},{"title":"Token access log export object","href":"/platform-api/token-access-logs/token-access-log-export"},{"title":"Export Token Access Logs","openapi":"POST /api/v1/token-access-logs/exports/","href":"/platform-api/token-access-logs/export"},{"title":"Get Token Access Log Export","openapi":"GET /api/v1/token-access-logs/exports/{id}/","href":"/platform-api/token-access-logs/export-details"}]}]},{"anchor":"MCP Server","icon":"server","pages":[{"title":"MCP Server","href":"/mcp-server/introduction"}]}]},"basePath":"","title":"Invite User - Nekt","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}