Create a workspace

POST

/v1/workspaces

const url = 'https://shareout.site/v1/workspaces';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","slug":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://shareout.site/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "slug": "example" }'

Any signed-in user can create a workspace.

Authorizations

bearerAuth

Request Body^required

application/json

object

name

required

string

slug

string

Example^generated

{
  "name": "example",
  "slug": "example"
}

Responses

200

Created

application/json

object

string

name

string

slug

string

role

string

Allowed values: owner admin member

Example

{
  "role": "owner"
}

Create a workspace

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

Example

Request Body^required

Example^generated