list_workspaces

GET

/v1/workspaces

const url = 'https://app.everruns.com/api/v1/workspaces';
const options = {method: 'GET'};

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://app.everruns.com/api/v1/workspaces

List Workspaces.

Parameters

Query Parameters

search

string | null

include_archived

boolean

Responses

200

Workspaces

application/json

Response wrapper for list endpoints. All list endpoints return responses wrapped in a data field.

object

data

required

Array of items returned by the list operation.

Array<object>

object

archived_at

string | null format: date-time

created_at

required

string format: date-time

deleted_at

string | null format: date-time

description

string | null

required

string

name

required

string

status

required

string

updated_at

required

string format: date-time

Example

{
  "data": [
    {
      "description": "Shared workspace for the Q4 research project",
      "id": "wsp_01933b5a000070008000000000000001",
      "name": "team-research",
      "status": "active"
    }
  ]
}