Get a workspace

GET

/api/workspaces/{id}

const url = 'http://localhost:8080/api/workspaces/example';
const options = {method: 'GET', headers: {cookie: 'auth_session=<auth_session>'}};

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

curl --request GET \
  --url http://localhost:8080/api/workspaces/example \
  --cookie auth_session=<auth_session>

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

required

string

Responses

200

The workspace.

application/json

object

success

required

boolean

data

required

object

string

name

required

string

slug

required

string

role

string

createdAt

string format: date-time

updatedAt

string format: date-time

settings

required

object

key

additional properties

Example

{
  "success": true,
  "data": {
    "id": "507f1f77bcf86cd799439011"
  }
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}