List users
The names your agents have sent for user identifiers.
Lists the users an organisation has named.
Request
GET /v1/organisations/{organisation}/usersGET /v1/organisations/{organisation}/workspaces/{workspace}/users
Parameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
pageSize |
query | integer | no | Maximum users to return. |
pageToken |
query | string | no | A page token from a previous response, to retrieve the next page. |
Response
| Field | Type | What it is |
|---|---|---|
users |
list of object | The users in this page. |
nextPageToken |
string | Token to retrieve the next page, empty when there are no more. |
Each item of the list
| Field | Type | What it is |
|---|---|---|
name |
string | The resource name of the user. |
displayName |
string | The person's name as the organisation would show it, e.g. Ada Lovelace. |
email |
string | The person's email address, where the organisation chooses to send it. |
createTime |
timestamp | When this user was first named. |
updateTime |
timestamp | When this user was last written. |
The OpenAPI document has every field. All methods.