Clerk docs

Invitations

Used to interact with the invitations of an organization. The current user must be an administrator to access them.

Create Organization Invitation

Create an invitation for a user to join an organization.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization for which the invitation will be created.

Request Body schema: application/x-www-form-urlencoded
required
email_address
required
string

The email address the invitation will be sent to.

role
required
string

The role that will be assigned to the user after joining. This can be one of the predefined roles (org:admin, org:basic_member) or a custom role.

Responses
200

Returns the response for Client wrapped OrganizationInvitation object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/invitations
Request samples
application/x-www-form-urlencoded
email_address=string&role=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get All Organization Invitations

Retrieve all invitations for an organization.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization for which the invitation will be retrieved.

query Parameters
limit
integer [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offset
integer >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

status
string
Enum: "pending" "accepted" "revoked" "invalid" "completed"
Responses
200

Returns the response for Client wrapped array of OrganizationInvitation objects.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

get/v1/organizations/{organization_id}/invitations
Response samples
application/json
{
  • "response": [
    ],
  • "client": {
    }
}

Bulk Create Organization Invitations

Create an invitation for a user to join an organization.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization for which the invitations will be created.

Request Body schema: application/x-www-form-urlencoded
required
email_address
required
Array of strings

An array of email addresses the invitations will be sent to.

role
required
string

The role that will be assigned to each of the users after joining. This can be one of the predefined roles (org:admin, org:basic_member) or a custom role.

Responses
200

Returns the response for Client wrapped array of OrganizationInvitation objects.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/invitations/bulk
Request samples
application/x-www-form-urlencoded
email_address=string&role=string
Response samples
application/json
{
  • "response": [
    ],
  • "client": {
    }
}

Get All Pending Organization InvitationsDeprecated

Get a list of pending invitations for an organization.

This endpoint is deprecated. Instead use the /v1/organizations/{organization_id}/invitations with a query parameter of status=pending.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization for which the invitations will be retrieved.

Responses
200

Returns the response for Client wrapped array of OrganizationInvitation objects.

401

Request was not successful

403

Request was not successful

422

Request was not successful

get/v1/organizations/{organization_id}/invitations/pending
Response samples
application/json
{
  • "response": [
    ],
  • "client": {
    }
}

Revoke Pending Organization Invitation

Revoke a pending organization invitation.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization for which the invitations will be retrieved.

invitation_id
required
string

The id of the invitation to revoke.

Responses
200

Returns the response for Client wrapped OrganizationInvitation object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

post/v1/organizations/{organization_id}/invitations/{invitation_id}/revoke
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to Membership Requests