Organization Invitations
4 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/organizations/{organizationIdOrSlug}/invitations | List organization invitations |
| POST | /api/v1/organizations/{organizationIdOrSlug}/invitations | Create an organization invitation |
| GET | /api/v1/organizations/{organizationIdOrSlug}/invitations/{invitationId} | Get an organization invitation |
| DELETE | /api/v1/organizations/{organizationIdOrSlug}/invitations/{invitationId} | Cancel an organization invitation |
List organization invitations
GET/api/v1/organizations/{organizationIdOrSlug}/invitations
Lists invitation metadata for the addressed Organization within the caller's live scope. Tokens and delivery credentials are never returned; results are bounded by an opaque cursor.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to List organization invitations. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List organization invitations. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List organization invitations. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create an organization invitation
POST/api/v1/organizations/{organizationIdOrSlug}/invitations
Creates a scoped invitation with optional Project role assignments and an expiry of no more than seven days. The Idempotency-Key makes retries safe; only metadata is returned and the invitation token is never exposed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Create an organization invitation. |
header
| Name | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | optional |
Request body
required — Request body for: Create an organization invitation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| string | required | ||
| role | "owner" | "admin" | "member" | optional | |
| expiresAt | string | optional | |
| projectRoles | array<object> | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
| 503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json PublicApiError
|
Get an organization invitation
GET/api/v1/organizations/{organizationIdOrSlug}/invitations/{invitationId}
Returns metadata for one invitation in the addressed Organization. Invitation tokens, encrypted delivery data, and provider details are never exposed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Get an organization invitation. |
| invitationId | string | required | Identifies the organization invitation being addressed. Applies to Get an organization invitation. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Cancel an organization invitation
DELETE/api/v1/organizations/{organizationIdOrSlug}/invitations/{invitationId}
Cancels a pending invitation in the addressed Organization using the existing locked invitation and delivery-outbox lifecycle. Accepted or missing invitations are not cancellable.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Cancel an organization invitation. |
| invitationId | string | required | Identifies the organization invitation being addressed. Applies to Cancel an organization invitation. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|