Members
Overview
Members are the users belonging to a workspace. The API exposes read access, plus admin-only endpoints for inviting new members and removing existing ones.
List Members
GET /api/members
Example Response
{
"data": [
{
"id": 1,
"name": "Alice Johnson",
"email": "alice@example.com",
"avatar_url": null,
"timezone": "UTC"
},
{
"id": 2,
"name": "Bob Williams",
"email": "bob@example.com",
"avatar_url": null,
"timezone": "America/New_York"
}
]
}
Invite Member (admin only)
Sends an invitation email to the given address.
POST /api/members/invite
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
email |
string | Yes | |
name |
string | No | |
role |
string | Yes | admin or member |
channel_ids |
array | No | IDs of channels the member can access |
Example Response
{
"data": {
"id": 12,
"email": "new@example.com",
"name": null,
"role": "member",
"invited_at": "2026-04-13T12:00:00+00:00"
}
}
Remove Member
DELETE /api/members/{user}
The {user} parameter is the user ULID. Owners cannot be removed. Members can remove themselves; otherwise admin role is required.