3.0.0
Search…
⌃K
Links

Organization Memberships

Backend API endpoints to create, update and delete user memberships in organizations

Overview

Organization memberships related requests which allow you to create new user memberships on an organization, update existing memberships or delete them.

Available requests

  • POST /v1/organizations/:organization_id/memberships
  • GET /v1/organizations/:organization_id/memberships
  • PATCH /v1/organizations/:organization_id/memberships/:user_id
  • PATCH /v1/organizations/:organization_id/memberships/:user_id/metadata
  • DELETE /v1/organizations/:organization_id/memberships/:user_id

Example organization membership schema

{
"object": "organization_membership",
"id": "orgmem_21Ufcy98STcA11s3QckIwtwHIES",
"public_metadata": {},
"private_metadata": {},
"role": "basic_member",
"organization": {
"object": "organization",
"id": "org_1o4qfak5AdI2qlXSXENGL05iei6",
"logo_url": "https://images.clerk.services/default-logo.png",
"name": "Acme Inc",
"private_metadata": {},
"public_metadata": {},
"slug": "acme-inc",
"created_at": 1638000669544,
"updated_at": 1638000669544
},
"created_at": 1638000669544,
"updated_at": 1638000669544,
"public_user_data": {
"first_name": "Sarah",
"last_name": "Connor",
"profile_image_url": "https://images.clerk.dev/uploaded/img_jlkkcq2786n0.jpeg",
"identifier": "[email protected]",
"user_id": "user_1o4q123qMeCkKKIXcA9h8"
}
}
post
https://api.clerk.dev
/v1/organizations/:organization_id/memberships
Create a new organization membership
get
https://api.clerk.dev
/v1/organizations/:organization_id/memberships
Retrieve all memberships for organization
patch
https://api.clerk.dev
/v1/organizations/:organization_id/memberships/:user_id
Update organization memberships
patch
https://api.clerk.dev
/v1/organizations/:organization_id/memberships/:user_id/metadata
Merge and update an organization membership's metadata
delete
https://api.clerk.dev
/v1/organizations/:organization_id/memberships/:user_id
Delete organization membership