Skip to main content
GET
/
workspace-users
cURL
curl --request GET \
  --url https://api.dock.us/{version}/workspace-users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "workspaceUsers": [
      {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "role": "owner",
        "user": {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "user",
          "url": "https://api.dock.us/v1/users/RiHO4e0Ju3DS",
          "firstName": "John",
          "lastName": "Doe",
          "avatar": "https://dock.us/avatar.png",
          "email": "john.doe@example.com",
          "name": "John Doe"
        }
      }
    ],
    "pageInfo": {
      "page": 1,
      "pages": 10,
      "total": 100,
      "pageTotal": 10,
      "hasNextPage": true,
      "hasPrevPage": false
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
properties
enum<string>[]

Select the workspace user properties that should be returned

Available options:
role,
createdAt,
updatedAt,
user.createdAt,
user.updatedAt,
user.firstName,
user.lastName,
user.avatar,
user.email,
user.name
​
filters
object

Filter workspace users

​
page
integer

Page number

​
limit
integer

Number of results to return

Response

Retrieve a list of workspace users

​
data
object