List workspaces

GET

/api/v1/workspaces

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces?per=10&page=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?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the workspaces

Authorizations

OAuth2
workspaces:read

Parameters

Query Parameters

per

integer

default: 10

Number of records per page

page

integer

default: 1

Page number

Responses

200

Successful

application/json

object

results

required

Array<object>

object

required

integer

name

required

string

auto_join

required

boolean

created_at

required

string format: date-time

pagination

required

object

per

required

integer

page

required

integer

total

required

integer

Example

{
  "results": [
    {
      "id": 12345,
      "name": "Default workspace",
      "auto_join": true,
      "created_at": "2023-08-23T10:30:00.000Z"
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

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"
}