Users API
Manage workspace users.
List Users
GET /v1/users
Returns users in a workspace.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace ID |
query | string | No | Search by name or email |
Example Response
{
"data": [
{
"id": "user_123",
"email": "john@acme.com",
"name": "John Doe",
"avatarUrl": "https://...",
"role": "editor",
"createdAt": "2024-06-15T10:00:00Z"
}
]
}
Get User
GET /v1/users/:userId
Returns a single user.
Update User
PUT /v1/users/:userId
Updates user profile.
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | Display name |
avatarUrl | string | No | Avatar URL |