Clerk docs

Organizations Memberships

Used to interact with the current user's organization memberships, invitations and suggestions.

Get Organization Memberships

Get a list of the organization memberships of the current user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
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.

paginated
boolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

Responses
200

Returns the response for Client wrapped array of OrganizationMembership objects.

401

Request was not successful

422

Request was not successful

get/v1/me/organization_memberships
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Organization Membership

Delete the membership of the given 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 membership will be deleted

Responses
200

Returns a deleted generic object.

400

Request was not successful

403

Request was not successful

404

Request was not successful

delete/v1/me/organization_memberships/{organization_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Current User's Organization Invitations

Get a list of the organization invitations of the current user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
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

The status of the organization invitations to filter by

Responses
200

Returns the response for Client wrapped array of OrganizationInvitation objects with user context.

401

Request was not successful

422

Request was not successful

get/v1/me/organization_invitations
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Accept Organization invitation

Accept an organization invitation for the current user.

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

The id of the organization invitation to accept

Responses
200

Returns the response for Client wrapped OrganizationInvitation object with user context.

401

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/me/organization_invitations/{invitation_id}/accept
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Organization Suggestions

Get a list of the organization suggestions of the current user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
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
Responses
200

Returns the response for Client wrapped array of OrganizationSuggestion objects with user context.

401

Request was not successful

422

Request was not successful

get/v1/me/organization_suggestions
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Accept Organization Suggestion

Accept an organization suggestion for the current user.

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

The id of the organization suggestion to accept

Responses
200

Returns the response for Client wrapped OrganizationSuggestion object with user context.

400

Request was not successful

401

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/me/organization_suggestions/{suggestion_id}/accept
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to Organization