Sign in

v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Workspaces

List workspace users

Returns a list of members in the given workspace. This list will be ordered with the requesting user first and then ordered by role.

get/workspaces/{workspaceId}/users

Path parameters

workspaceIdstring required

ID of the workspace.

Query parameters

includedRolesWorkspaceUserRole[]

Show only the members that match the included roles. Multiple roles can be specified with a comma-delimited list.

pageTokenstring

An opaque token used to fetch the next page of results.

Response

List of workspace members matching the query.

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "email": "hello@example.com",
      "name": "Sally Jane",
      "pictureUrl": "codahosted.io/123",
      "registeredAt": "2018-04-11T00:18:57.946Z",
      "roleChangedAt": "2018-04-11T00:18:57.946Z",
      "lastActiveAt": "2018-04-11",
      "ownedDocs": 2,
      "docsLastActiveAt": "2018-04-11",
      "docCollaboratorCount": 2,
      "totalDocs": 2,
      "totalDocsLastActiveAt": "2018-04-11",
      "totalDocCollaboratorsLast90Days": 2
    }
  ],
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/workspaces/{workspaceId}/users?pageToken=xyz"
}