Workspaces

Endpoint shortcuts

POSThttps://data.datablist.com/

GEThttps://data.datablist.com/:workspace_id

PATCHhttps://data.datablist.com/:workspace_id

PUThttps://data.datablist.com/:workspace_id

GEThttps://data.datablist.com/

DELETEhttps://data.datablist.com/:workspace_id

The Workspace object#

{
  "@context": {...},
  "@id": "xbDsSfcswWPoYnUN8vJ",
  "@type": "Workspace",
  "user_id": "auth0|5f04po976078900139bb58a",
  "name": "Acme Workspace",
  "createdAt": "2020-07-08T09:31:10.303945",
  "updatedAt": "2020-07-08T09:31:10.303961",
}

Properties#

Property	Type	Description
@context	object	Optional
@id	string	Unique identifier for the object
@type	string	Value is "Workspace"
user_id	string	The ID of the User that created it.
name	string	Name of the Workspace. Is shown on the Datablist App.
createdAt	string	Timestamp of object creation, expressed according to ISO 8601.
updatedAt	string	Timestamp of object last update, expressed according to ISO 8601.

List all workspaces#

GET https://data.datablist.com

This will list the workspaces for your current account.

curl https://data.datablist.com \
    -H "Authorization: Bearer {{YOUR ACCESS TOKEN}}"

Response

{
  "@context": {...},
  "data": [{
    "user_id": "auth0|5f0476c976004400139bb58a",
    "name": "Acme Workspace",
    "createdAt": "2020-07-08T09:31:10.303945",
    "updatedAt": "2020-07-08T09:31:10.303961",
    "@id": "xbDnos4GHeCO7YnUN8vJ"
  }]
}

Create a workspace#

POST https://data.datablist.com

{
  "name": "Acme Workspace",
  "@type": "Workspace"
}

Any extra field will return a bad request error.

On success, returns a HTTP code 201 with {"@id": "WORKSPACE_ID"}

Retrieve a workspace#

GET https://data.datablist.com/:workspace_id

Response

{
  "@context": {...},
  "@id": "xbDsSfcswWPoYnUN8vJ",
  "@type": "Workspace",
  "user_id": "auth0|5f04po976078900139bb58a",
  "name": "Acme Workspace",
  "createdAt": "2020-07-08T09:31:10.303945",
  "updatedAt": "2020-07-08T09:31:10.303961",
}

Update a workspace#

Updates can be performed with PATCH, by sending only the fields to be updated, or with PUT which requires the whole object.

Partial#

PATCH https://data.datablist.com/:workspace_id

{
  "name": "Updated name"
}

On success, returns an empty HTTP 204 No Content.

Full update#

PUT https://data.datablist.com/:workspace_id

{
  "name": "Updated name",
  "@type": "Space"
}

On success, returns an empty HTTP 204 No Content.

Delete a workspace#

DELETE https://data.datablist.com/:workspace_id

On success, returns an empty HTTP 204 No Content.

caution

Currently, workspace creation and delete through the API require special privilege. Please contact us if you need access.