Skip to main content

​
List members

Retrieve a paginated list of members for a given community. 
GET /v1/communities/:community_id/members
Query parameters:
ParameterTypeDescription
pageintPage number (default: 1).
per_pageintItems per page (max 50).
rolestringFilter by role: owner, admin, moderator, or member.
searchstringSearch by display name or username.
Response: 
{
  "data": [
    {
      "id": "uuid",
      "user_id": "uuid",
      "username": "johndoe",
      "display_name": "John Doe",
      "role": "member",
      "joined_at": "2025-01-15T00:00:00Z",
      "xp": 1250,
      "level": 5
    }
  ]
}
FieldTypeDescription
idstringUnique membership record ID.
user_idstringThe user’s account ID.
usernamestringThe user’s unique handle.
display_namestringThe user’s public name.
rolestringOne of owner, admin, moderator, member.
joined_atstringISO 8601 timestamp of when the user joined.
xpintTotal experience points earned in this community.
levelintCurrent gamification level.

​
Get member

Retrieve the details of a specific member in a community. 
GET /v1/communities/:community_id/members/:user_id
Response: Returns the full member object as shown above.

​
Update member role

Change the role of a member within a community. You must be an owner or admin to perform this action. 
PATCH /v1/communities/:community_id/members/:user_id
Request body: 
{
  "role": "moderator"
}
FieldTypeRequiredDescription
rolestringYesNew role: admin, moderator, or member.
You cannot change a member’s role to owner. Ownership transfer is handled separately in the dashboard.

​
Remove member

Remove a member from the community. The user loses access immediately. 
DELETE /v1/communities/:community_id/members/:user_id
This removes the member and their role from the community. Their posts and activity history are retained.