Workspace users
Retrieve a workspace user
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Workspace users
Retrieve a workspace user
Retrieve a workspace user by ID
GET
/
workspace-users
/
{id}
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-users/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspaceUser": {
"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"
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier
Example:
"RiHO4e0Ju3DS"
Query Parameters
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
Response
200
application/json
Retrieve a workspace user by ID
Id of the object
Example:
"RiHO4e0Ju3DS"
Last updated date
Example:
"2021-01-01T00:00:00.000Z"
Created at date
Example:
"2021-01-01T00:00:00.000Z"
Role of the user to access the workspace
Available options:
owner
, editor
, collaborator
, viewer
, commenter
Example:
"owner"
Id of the object
Example:
"RiHO4e0Ju3DS"
Last updated date
Example:
"2021-01-01T00:00:00.000Z"
Created at date
Example:
"2021-01-01T00:00:00.000Z"
Type of the object
Available options:
user
Example:
"user"
URL to the resource
Example:
"https://api.dock.us/v1/users/RiHO4e0Ju3DS"
First name of the user
Example:
"John"
Last name of the user
Example:
"Doe"
Avatar of the user
Example:
"https://dock.us/avatar.png"
Email of the user
Example:
"john.doe@example.com"
Name of the user
Example:
"John Doe"
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-users/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspaceUser": {
"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"
}
}
}
}