POST /organizations/:organization_id/invitations

svc-org-management_other

Create an invitation to join an organization

post/organizations/{organization_id}/invitations

Path parameters

organization_idstring required

Organization ID or label identifier

Organization ID or label

Headers

X-Client-Request-IDstring uuid

Unique request identifier specified by the originating caller and passed along by proxies.

Request body

emailstring email required

Email address to invite

role'org_admin' | 'org_member' | 'org_viewer' required

User's role in the organization

Response

Invitation created successfully

idstring required

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

emailstring email required

Email address for the invitation

organization_idstring required

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

created_atstring date-time required

The time the entity was created in utc

updated_atstring date-time required

The time the entity was mostly recently updated in utc

created_bystring required

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

role'org_admin' | 'org_member' | 'org_viewer' required

User's role in the organization

status'pending' | 'accepted' | 'expired' | 'revoked' required

Status of an invitation

expires_atstring date-time required

When the invitation expires

permissionsOrgManagementPermissions

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.

Example response

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "organization_id": "ab3def8hij2klm9opq5rst7uvw",
  "created_by": "ab3def8hij2klm9opq5rst7uvw",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}

Changes

Changed in 3 of the 23 revisions of this API.116

Mar 16, 2026d3d69f45bfed3See the full diff
- ○
  the endpoint scheme security OAuth2 was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security org-management_bearerAuth was removed from the API
  api-security-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 24, 20260aa1f5c87e8111See the full diff
- ▲
  the request property became required
  request-property-became-required
- ○
  the request property default value org_admin was removed
  request-property-default-value-removed
Feb 6, 2026edd1b760a98912See the full diff
- ●
  deleted the header request parameter X-Request-ID
  request-parameter-removed
- ○
  the endpoint scheme security org-management_bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security svc-org-management_bearerAuth was removed from the API
  api-security-removed
This revision also has 82 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history