Get workspace

GET

/api/v1/workspaces/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1 \
  --header 'Authorization: Bearer <token>'

Retrieves a single workspace by ID.

Authorizations

OAuth2
workspaces:read

Parameters

Path Parameters

required

integer

Workspace ID

Responses

200

Successful

application/json

object

required

integer

name

required

string

auto_join

required

boolean

created_at

required

string format: date-time

Example

{
  "id": 12345,
  "name": "Default workspace",
  "auto_join": true,
  "created_at": "2023-08-23T10:30:00.000Z"
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}