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.

{ "nextPageToken": "eyJsaW1pd", "items": [ { "role": "Admin", "email": "hello@coda.io", "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 } ], "nextPageLink": "https://coda.io/apis/v1/workspaces/{workspaceId}/users?pageToken=xyz" }

请求参数

Path 参数

workspaceId

string

必需

ID of the workspace.

示例值:

ws-1Ab234

Query 参数

includedRoles

array[string]

可选

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

枚举值:

AdminDocMakerEditor

示例值:

Editor,DocMaker

pageToken

string

可选

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

示例值:

eyJsaW1pd

返回响应

🟢200List of workspace members matching the query.

application/json

Body

Response for listing workspace users.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[object (WorkspaceUser) {13}]

必需

role

enum<string>

必需

枚举值:

AdminDocMakerEditor

string

必需

Email of the user.

示例值:

hello@coda.io

name

string

必需

Name of the user.

示例值:

Sally Jane

pictureUrl

string <url>

可选

Picture url of the user.

示例值:

codahosted.io/123

registeredAt

string <date-time>

必需

Timestamp for when the user registered in this workspace

示例值:

2018-04-11T00:18:57.946Z

roleChangedAt

string <date-time>

必需

Timestamp for when the user's role last changed in this workspace.

示例值:

2018-04-11T00:18:57.946Z

lastActiveAt

string <date>

可选

Date when the user last took an action in any workspace.

示例值:

2018-04-11

ownedDocs

number

可选

Number of docs the user owns in this workspace.

示例值:

docsLastActiveAt

string <date>

可选

Date when anyone last accessed a doc that the user owns in this workspace.

示例值:

2018-04-11

docCollaboratorCount

number

可选

Number of collaborators that have interacted with docs owned by the user in the last 90 days.

示例值:

totalDocs

number

可选

Number of docs the user owns, manages, or to which they have added pages in the last 90 days.

示例值:

totalDocsLastActiveAt

string <date>

可选

Date when anyone last accessed a doc the member owns or contributed to.

示例值:

2018-04-11

totalDocCollaboratorsLast90Days

number

可选

Number of unique users that have viewed any doc the user owns, manages, or has added pages to in the last 90 days.

示例值:

nextPageLink

string <url>

可选

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

示例值:

https://coda.io/apis/v1/workspaces/{workspaceId}/users?pageToken=xyz

🟠401401

🟠403403

🟠404404

🟠429429