Workspaces

Create a workspace

Other errors (500, 502, 503) are on Errors.

POST
/v1/workspaces

Other errors (500, 502, 503) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Request Body

application/json

namestringrequired

Unique among the account's live workspaces, ignoring case. Leading and trailing spaces are trimmed.

Length1 <= length <= 120
domain_slugstring

The published domain the workspace sorts its files into: generic, the general-purpose default; a domain your account published; or one Nace provides. The workspace pins the newest published version at the time. Left out, generic. Can't change later. A slug that names no published domain you can use is 422 invalid_request.

Match^[a-z0-9]+(?:_[a-z0-9]+)*$
Lengthlength <= 64
accessWorkspace access

labels (up to 16 {name, description}) and default_label. Can't change later.

Show child attributes

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces" \  -H "Content-Type: application/json" \  -d '{    "name": "fy25-audit"  }'
{  "workspace_id": "string",  "name": "string",  "owner_user_id": "string",  "access": {    "labels": [      {        "name": "string",        "description": "string"      }    ],    "default_label": "string"  },  "domain_id": "string",  "domain_slug": "string",  "domain_version": 0,  "config_version": 0,  "status": "active",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}