Users
Retrieve a list of users
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Users
Retrieve a list of users
GET
/
users
curl --request GET \
--url https://api.dock.so:4000/{version}/users \
--header 'Authorization: Bearer <token>'
{
"data": {
"users": [
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page number
Number of results to return
Select the user properties that should be returned
Available options:
firstName
, lastName
, avatar
, email
, name
, createdAt
, updatedAt
Response
200
application/json
List of users
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"
Current page number
Example:
1
Total number of pages
Example:
10
Total number of items
Example:
100
Number of items on the current page
Example:
10
Whether there is a next page
Example:
true
Whether there is a previous page
Example:
false
curl --request GET \
--url https://api.dock.so:4000/{version}/users \
--header 'Authorization: Bearer <token>'
{
"data": {
"users": [
{
"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
}
}
}