Workspace domains
Retrieve a list of workspace domains
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Workspace domains
Retrieve a list of workspace domains
Retrieve a list of workspace domains
GET
/
workspace-domains
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-domains \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspaceDomains": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"role": "owner",
"domain": "dock.us"
}
],
"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
Select the workspace domain properties that should be returned
Available options:
role
, domain
, createdAt
, updatedAt
Filter workspace domains
Filter workspace domains by a workspace ID
Example:
"RiHO4e0Ju3DS"
Page number
Number of results to return
Response
200
application/json
Retrieve a list of workspace domains
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"
Domain of the workspace user
Example:
"dock.us"
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}/workspace-domains \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspaceDomains": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"role": "owner",
"domain": "dock.us"
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}