Skip to content
ShaireDevelopers
Get a token

cycle-cadences

7 endpoints.

get/api/cycle-cadences#

tickets:read
Request
curl https://api.shairelabs.com/api/cycle-cadences \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · CycleCadence[]

idstring · uuid*
workspaceIdstring · uuid*
folderIdstring · uuid | null*
namestring*
nameTemplatestring*
anchorOnstring*
lengthDaysinteger*
generateAheadinteger*
numberOffsetinteger*
autoRolloverboolean*
emptyCyclesBeforePauseinteger*
pausedAtstring | null*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

post/api/cycle-cadences#

tickets:write

Body

folderIdstring · uuid | null
default null
namestring*
min length 1 · max length 120
nameTemplatestring*
min length 1 · max length 120
anchorOnstring · date*
lengthDaysinteger
min 1 · max 90 · default 14
generateAheadinteger
min 1 · max 12 · default 2
numberOffsetinteger
min 1 · max 9999
autoRolloverboolean
default true
emptyCyclesBeforePauseinteger
min 1 · max 12 · default 2
Request
curl https://api.shairelabs.com/api/cycle-cadences \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","nameTemplate":"example","anchorOn":"2026-01-31"}'

Response · 201 · CycleCadenceDetail

idstring · uuid*
workspaceIdstring · uuid*
folderIdstring · uuid | null*
namestring*
nameTemplatestring*
anchorOnstring*
lengthDaysinteger*
generateAheadinteger*
numberOffsetinteger*
autoRolloverboolean*
emptyCyclesBeforePauseinteger*
pausedAtstring | null*
createdAtstring*
updatedAtstring*
upcomingobject[]*
[item]object
indexinteger*
numberinteger*
namestring*
startsOnstring*
endsOnstring*
recentEmptyCyclesinteger*
unendedCycleCountinteger*

Also answers 401 and 403. SeeErrors.

get/api/cycle-cadences/{id}#

tickets:read

Path

idstring*
Request
curl https://api.shairelabs.com/api/cycle-cadences/$CYCLE_CADENCE_ID \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · CycleCadenceDetail

idstring · uuid*
workspaceIdstring · uuid*
folderIdstring · uuid | null*
namestring*
nameTemplatestring*
anchorOnstring*
lengthDaysinteger*
generateAheadinteger*
numberOffsetinteger*
autoRolloverboolean*
emptyCyclesBeforePauseinteger*
pausedAtstring | null*
createdAtstring*
updatedAtstring*
upcomingobject[]*
[item]object
indexinteger*
numberinteger*
namestring*
startsOnstring*
endsOnstring*
recentEmptyCyclesinteger*
unendedCycleCountinteger*

Also answers 401 and 403. SeeErrors.

patch/api/cycle-cadences/{id}#

tickets:write

Path

idstring*

Body

namestring
min length 1 · max length 120
nameTemplatestring
min length 1 · max length 120
anchorOnstring · date
lengthDaysinteger
min 1 · max 90
generateAheadinteger
min 1 · max 12
autoRolloverboolean
emptyCyclesBeforePauseinteger
min 1 · max 12
Request
curl https://api.shairelabs.com/api/cycle-cadences/$CYCLE_CADENCE_ID \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · CycleCadenceDetail

idstring · uuid*
workspaceIdstring · uuid*
folderIdstring · uuid | null*
namestring*
nameTemplatestring*
anchorOnstring*
lengthDaysinteger*
generateAheadinteger*
numberOffsetinteger*
autoRolloverboolean*
emptyCyclesBeforePauseinteger*
pausedAtstring | null*
createdAtstring*
updatedAtstring*
upcomingobject[]*
[item]object
indexinteger*
numberinteger*
namestring*
startsOnstring*
endsOnstring*
recentEmptyCyclesinteger*
unendedCycleCountinteger*

Also answers 401 and 403. SeeErrors.

delete/api/cycle-cadences/{id}#

tickets:write

Path

idstring*

Query

sprintsstring
keepdiscarddefault "keep"
Request
curl https://api.shairelabs.com/api/cycle-cadences/$CYCLE_CADENCE_ID \
  -X DELETE \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 204

Also answers 401 and 403. SeeErrors.

post/api/cycle-cadences/{id}/archive-ended#

tickets:write

Path

idstring*
Request
curl https://api.shairelabs.com/api/cycle-cadences/$CYCLE_CADENCE_ID/archive-ended \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · ArchivedCycleCount

archivedinteger*

Also answers 401 and 403. SeeErrors.

post/api/cycle-cadences/{id}/resume#

tickets:write

Path

idstring*
Request
curl https://api.shairelabs.com/api/cycle-cadences/$CYCLE_CADENCE_ID/resume \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · CycleCadenceDetail

idstring · uuid*
workspaceIdstring · uuid*
folderIdstring · uuid | null*
namestring*
nameTemplatestring*
anchorOnstring*
lengthDaysinteger*
generateAheadinteger*
numberOffsetinteger*
autoRolloverboolean*
emptyCyclesBeforePauseinteger*
pausedAtstring | null*
createdAtstring*
updatedAtstring*
upcomingobject[]*
[item]object
indexinteger*
numberinteger*
namestring*
startsOnstring*
endsOnstring*
recentEmptyCyclesinteger*
unendedCycleCountinteger*

Also answers 401 and 403. SeeErrors.