Skip to main content
GET
/
cycles
/
read
Read cycle by id
curl --request GET \
  --url https://api.obselite.com/v0/cycles/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "number": 123,
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "hours": 123,
  "daysOff": [
    "<string>"
  ],
  "isEnabled": true,
  "lockedAt": "<string>",
  "organization": {},
  "team": {},
  "status": {},
  "tasks": [
    {}
  ],
  "links": [
    {}
  ],
  "files": [
    {}
  ],
  "activities": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

The API token generated from the Obselite dashboard

Query Parameters

filter
string

Encoded JSON to search and refine lists, see filtering

include
string

Available options: status, tasks, links, files, activities

id
string<uuid>

Response

Successful response

id
string<uuid>
required

Cycle UUID

number
integer
required
description
required
startDate
string
required
daysOff
string[]
required
isEnabled
boolean
required
name
string | null
statusId
string<uuid> | null

Status UUID

endDate
string | null
hours
integer | null
lockedAt
string | null
organization
object | null

The organization that owns this cycle, following the organization schema

team
object | null

The team that this cycle is associated with, following the team schema

status
object | null

The current status of this cycle, following the status schema

tasks
array
files
array
activities
array