Skip to main content

What are Members?

Members are users who belong to your Network. The Members API allows you to list, search, view, and manage member data, profiles, permissions, and roles.

Member Properties

Each member includes:
  • Member ID - Unique identifier for the member
  • Email - Member’s email address
  • Name - First and last name
  • Profile Data - Avatar, location, timezone, bio
  • Role - Admin, host, or member
  • Created At - When they joined the Network
  • Activity - Engagement metrics and participation
  • Custom Fields - Additional profile information

Listing Members

Get all members in your Network:

Pagination

Use pagination parameters to navigate through large member lists:

Getting a Specific Member

Retrieve details about a single member by their ID:

Example Response

Member Roles

Members can have different roles within your Network:

Role Types

  • Admin - Full Network management access, can manage all settings and content
  • Host - Can manage specific spaces and moderate content
  • Member - Standard Network access with basic permissions
  • Guest - Limited access to specific content (if enabled)

Updating Member Roles

Change a member’s role in the Network:

Space Membership

Members can belong to specific spaces within your Network.

Listing Members in a Space

Get members of a specific space:

Getting Space Member Details

Get a specific member’s details within a space:

Banning Members

Ban a user from the Network:
Banning a member removes them from the Network and prevents them from rejoining.

Common Use Cases

Search for members by email or name:

Member Activity Report

Generate a report of member activity:

Bulk Role Updates

Update roles for multiple members:

CRM Integration

Sync member data with external CRM:

Best Practices

  1. Use Pagination - Always paginate through member lists to avoid timeouts
  2. Respect Rate Limits - Add delays when performing bulk operations
  3. Cache Member Data - Store frequently accessed member data locally
  4. Validate Permissions - Ensure your API token has the necessary member scopes
  5. Handle Errors Gracefully - Check for 404 errors when accessing specific members
  6. Protect Privacy - Never expose sensitive member data publicly

Next Steps

Spaces

Learn about organizing members in spaces.

Custom Fields

Work with custom member profile fields.

Authentication

Manage API token permissions for member access.

Pagination

Learn pagination best practices.