Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Get Workspaces Users

Returns all workspace_users for a given workspace if workspace_id is provided. Otherwise, returns all workspace_users for all workspaces that the requesting user is part of.

Not accessible by guests.

get/api/v1/workspaces/users

Query parameters

workspace_idinteger nullable

ID of the workspace to list users for.

Example:123456
cursorstring nullable

An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request

Example:14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55
limitinteger

Maximum number of workspace users to return.

Example:50
sort'id' | 'name'

Order workspace users by ID, or by name with the requesting user first. Name sorting requires workspace_id.

Example:name

Response

Successful Response

has_moreboolean required

Whether more results are available.

next_cursorstring

Cursor for the next page of results.

Example response

{
  "next_cursor": "eyJpZCI6MTIzfQ",
  "workspace_users": [
    {
      "full_name": "Dain Ironfoot",
      "image_id": "abc123",
      "is_deleted": false,
      "role": "MEMBER",
      "timezone": "Europe/Madrid",
      "user_email": "example@email.org",
      "user_id": "1234567",
      "workspace_id": "123456"
    }
  ]
}