Users API | Product Documentation

The Users API provides access to user profiles, search, and activity streams. Users are associated with workspaces through workspace permissions, which can be assigned directly or through groups.

List Users

Retrieve a paginated list of all users.


Method	`GET`
Path	`/api/v3/users`
Auth	Bearer token required

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination

Response 200 OK

JSON

{
  "count": 42,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "username": "jdoe",
      "email": "jdoe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "isActive": true
    }
  ]
}

Get User

Retrieve details for a specific user.


Method	`GET`
Path	`/api/v3/users/{user_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns the full user profile.

Update User

Update a user's profile information.


Method	`PUT`
Path	`/api/v3/users/{user_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns the updated user object.

Partial Update User

Partially update a user's profile (only modified fields).


Method	`PATCH`
Path	`/api/v3/users/{user_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns the updated user object.

Delete User

Delete a user account.


Method	`DELETE`
Path	`/api/v3/users/{user_id}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 204 No Content

Search Users

Search for users by name or email.


Method	`GET`
Path	`/api/v3/users/search`
Auth	Bearer token required

Query Parameters

Parameter	Type	Required	Description
`q`	string	Yes	Search query (matches against username, email, first name, last name)

Response 200 OK

Returns a list of matching user objects.

Get User Active Workspaces

Retrieve workspaces where a user is currently active.


Method	`GET`
Path	`/api/v3/users/{user_id}/activeworkspaces`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns a list of workspaces the user has recently been active in.

Get User Activities

Retrieve the activity feed for a specific user.


Method	`GET`
Path	`/api/v3/users/{user_id}/activities`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns a list of recent activity events for the user.

Get User Activity Count

Retrieve the total count of activities for a user.


Method	`GET`
Path	`/api/v3/users/{user_id}/activities/count`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns the total activity count.

Get User Activity Stream

Retrieve the real-time activity stream for a user.


Method	`GET`
Path	`/api/v3/users/{user_id}/stream`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`user_id`	integer	The ID of the user

Response 200 OK

Returns a stream of activity events for the user.