List your suites as a tree

GET

/v1/suites

const url = 'https://beta-api.plune.ai/v1/suites';
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://beta-api.plune.ai/v1/suites \
  --header 'Authorization: Bearer <token>'

Roots at the top level, each with its children nested in position order and its caseCount (a folder sums its subtree). Only your project’s nodes.

Authorizations

bearerAuth
cookieAuth

Responses

200

Your suite forest

application/json

object

suites

required

Array

A suite with its children nested — the recursive shape GET /v1/suites returns.

object

schemaVersion

required

integer

Allowed values: 1

required

string format: uuid

name

required

string

parentId

Absent on a root node. Always a folder.

string

projectId

required

string

kind

required

string

Allowed values: folder suite

position

required

Order among siblings — dense and 0-based; every write that places a node renumbers them.

integer

description

Free text, up to 16 384 bytes of UTF-8. Absent when empty.

string

file

The spec path this suite was filed from (an automated case’s specRef, normalised). Set by filing alone and never by hand; absent on nodes a person made.

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

children

required

Array recursive

caseCount

required

Test cases in this suite; on a folder, the sum over its whole subtree.

integer

Example

{
  "suites": [
    {
      "schemaVersion": 1,
      "name": "Checkout",
      "kind": "folder",
      "file": "apps/web/e2e/catalog/search.spec.ts"
    }
  ]
}

401

No / invalid token or session