Get workspace readiness checks

GET/workspaces/{organizationId}/readiness

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Responses

200

Workspace readiness

readybooleanrequired

checksobject[]required

Show properties

Array of object

namestringrequired

okbooleanrequired

requiredbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Request

curl -X GET 'https://pile.nyc/workspaces/string/readiness' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/readiness", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/readiness",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "ready": true,
  "checks": [
    {
      "name": "string",
      "ok": true,
      "required": true
    }
  ]
}