List cycles

GET/workspaces/{organizationId}/cycles

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

Cycles list

cyclesobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

projectIdstring | nullrequired

namestringrequired

numbernumber | nullrequired

statusstringrequired

Allowed:upcomingactivecompleted

autoRolloverbooleanrequired

archivedAtstring | nullrequired

startDatestring | nullrequired

endDatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

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/cycles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

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

Response

{
  "cycles": [
    {
      "id": "string",
      "organizationId": "string",
      "projectId": "string",
      "name": "string",
      "number": 0,
      "status": "upcoming",
      "autoRollover": true,
      "archivedAt": "string",
      "startDate": "string",
      "endDate": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}