Users
List users and view activity within your organization.
Users represent the people in your organization. You can list members, view their profiles, and check their activity.
List Users
GET /api/v1/usersPermission required: members:view
Returns all users in the organization.
Example Response
[
{
"id": "usr_abc123",
"email": "[email protected]",
"name": "Alex Smith",
"role": "Admin",
"createdAt": "2025-01-15T10:00:00Z"
},
{
"id": "usr_def456",
"email": "[email protected]",
"name": "Jamie Lee",
"role": "TeamMember",
"createdAt": "2025-02-01T09:00:00Z"
}
]Get User
GET /api/v1/users/{userId}Permission required: members:view
Returns details for a specific user.
Get Activity Summary
GET /api/v1/users/{userId}/activity-summaryPermission required: members:view
Returns an activity summary for a user, including event counts and most-viewed boards.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | No | Start date (ISO 8601) |
| to | string | No | End date (ISO 8601) |
Example Response
{
"userId": "usr_abc123",
"period": {
"from": "2025-03-01T00:00:00.000Z",
"to": "2025-03-31T23:59:59.999Z"
},
"eventCounts": {
"ticketCreated": 12,
"commentAdded": 34,
"statusChanged": 8
},
"lastActivityAt": "2025-03-20T15:30:00.000Z",
"mostViewedBoards": [
{ "boardId": "brd_abc123", "name": "Website Redesign", "viewCount": 45 }
]
}