Organization Invitations
5 operations.
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/invitations/{invitationId}/accept | Accept an invitation |
| 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 |
Accept an invitation
POST /api/v1/invitations/{invitationId}/accept
Join the Organization and Projects named by an invitation sent to your verified email. Supply the invitation token, not an inviter API key. Acceptance does not switch your current Organization or change existing API key scopes.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | required | Identifies the organization invitation being addressed. Applies to Accept an invitation. |
Request body
Required — Request body for: Accept an invitation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
token | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
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 | one of 2 types | 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 — data: object (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
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 | one of 2 types | required | Identifies the organization by its stable identifier or slug. Applies to Create an organization invitation. |
header
| Name | Type | Required | Description |
|---|---|---|---|
Idempotency-Key | string | required |
Request body
Required — Request body for: Create an organization invitation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
email | string | required | |
role | "member" | "admin" | "owner" | optional | |
expiresAt | string | optional | |
projectRoles | array<object> | optional |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
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 | one of 2 types | 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 — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Cancel an organization invitation
DELETE /api/v1/organizations/{organizationIdOrSlug}/invitations/{invitationId}
Cancels a pending invitation in the addressed Organization and removes its outstanding delivery. Accepted or missing invitations are not cancellable.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdOrSlug | one of 2 types | 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 — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |