Manage memberships that link people to workspaces within your Well organization. Memberships define user access and roles within specific workspaces.

​
Getting Started

The Memberships API allows you to create and manage membership records that establish relationships between people and workspaces.

Create your first Membership

Start by creating a membership linking a person to a workspace

​
How Membership Management Works

  1. Create memberships: Link people to workspaces with specific roles
  2. Manage roles: Define user permissions within workspaces
  3. Access control: Control who can access which workspaces
  4. Organization scoped: Memberships are scoped to your organization
  5. Lifecycle management: Track creation, updates, and deletion of memberships

​
Membership Roles

When creating memberships, you can specify roles that determine permissions:
  • Admin: Full administrative access to the workspace
  • Member: Standard member access
  • Viewer: Read-only access
  • Guest: Limited access with specific permissions

​
Quick Start Examples

// Create a membership
const response = await fetch('https://api.wellapp.ai/v1/memberships', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      type: 'membership',
      attributes: {
        membership_role: 'member'
      },
      relationships: {
        person: {
          data: {
            type: 'people',
            id: 'person-uuid'
          }
        },
        workspace: {
          data: {
            type: 'workspace',
            id: 'workspace-uuid'
          }
        }
      }
    }
  })
});

​
Key Features

  • JSON:API Standard: All endpoints follow JSON:API specification for consistency
  • Role-based Access: Define granular permissions through membership roles
  • Workspace Isolation: Memberships are workspace-specific for security
  • Filtering & Pagination: Efficient data retrieval with query parameters
  • Real-time Updates: Track membership changes with webhooks