The company membership object

{
  "id": "mem_123456789",
  "object": "companyMembership",
  "attributes": {
    "role": "admin",
    "department": "engineering",
    "join_date": "2024-01-15T00:00:00.000Z",
    "access_level": "full",
    "status": "active"
  },
  "createdAt": "2024-03-20T08:30:00.000Z",
  "company": null,
  "companyId": "comp_987654321",
  "user": null,
  "userId": "usr_123456789"
}

Overview

Company memberships establish a flexible many-to-many relationship model between users and companies. This design allows:

A single user to belong to multiple companies
A company to have multiple user members
Different roles and permissions for the same user across different companies

The membership object serves as the ideal place to store relationship-specific data, particularly user roles and permissions. For instance, a user might be an Owner in one company while serving as an Admin in another. This role information belongs in the membership attributes rather than the user or company objects, as it represents the specific relationship between a user and a company. Company memberships serve as the connection between users and companies, enabling you to:

Track user-company relationships
Store relationship-specific attributes
Manage user access and permissions
Track membership history and changes

Object structure

string

Unique identifier for the membership. The system automatically generates this ID when a new membership is created.

string

String representing the object’s type. Always set to "companyMembership".

object

A map of custom attributes that describe the user’s relationship with the company. You can store any data relevant to this specific membership, such as:

Membership status and type
Access levels and permissions
Department and role information
Custom preferences and settings

string

ISO 8601 timestamp in UTC indicating when the membership was created in the system. For tracking when the user joined your application, use a custom attribute like joined_at in the user’s attributes object.

object | null

default:"null"

The associated company object. This field defaults to null but can be expanded using ?expand=company to include the full company details.

string

The unique identifier of the associated company. This ID can be used to reference the company in other API calls.

object | null

default:"null"

The associated user object. This field defaults to null but can be expanded using ?expand=user to include the full user details.

string

The unique identifier of the associated user. This ID can be used to reference the user in other API calls.

{
  "id": "mem_123456789",
  "object": "companyMembership",
  "attributes": {
    "role": "admin",
    "department": "engineering",
    "join_date": "2024-01-15T00:00:00.000Z",
    "access_level": "full",
    "status": "active"
  },
  "createdAt": "2024-03-20T08:30:00.000Z",
  "company": null,
  "companyId": "comp_987654321",
  "user": null,
  "userId": "usr_123456789"
}

List companies Upsert a membership

API References

Users

Companies

Company Memberships

Content

Content Versions

Content Sessions

Event Definitions

Attribute Definitions

Overview

Object structure

​Overview

​Object structure

Overview

Object structure