Skip to content
Navigation

Get season lifecycle

GET
https://api.sureshake.com/v2/execution/cycles/{cycleId}/lifecycle

Path parameters

  • cycleId
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • season
      object
      required
      • id
        string
        required
        format: uuid
      • entityId
        string
        required
        format: uuid
      • label
        string
        required
        maxLength: 120 · minLength: 1
      • cycleType
        string
        required
      • startDate
        string
        required
        format: date-time
      • endDate
        string
        required
        format: date-time
      • status
        planning
        or
        locked
        or
        active
        or
        resolution_open
        or
        closed
        or
        paused
        +4 more
        required
      • baselineId
        string
        or null
        required
        format: uuid
      • primaryOutcome
        string
        or null
        required
        maxLength: 4000 · minLength: 1
      • ownerUserId
        string
        or null
        required
        minLength: 1
      • cadence
        weekly
        or
        biweekly
        or
        monthly
        or null
        required
      • visibility
        public
        or
        follower
        or
        capital
        or
        diligence
        or
        custom
        or null
        required
      • durationMode
        eight_week_template
        or
        custom
        or null
        required
      • durationTemplate
        eight_week
        or null
        required
      • activatedBy
        string
        or null
        required
        minLength: 1
      • activatedAt
        string
        or null
        required
        format: date-time
      • createdBy
        string
        or null
        required
        minLength: 1
      • createdAt
        string
        required
        format: date-time
      • updatedAt
        string
        required
        format: date-time
    • events
      array of
      object
      required
      • id
        string
        required
        format: uuid
      • entityId
        string
        required
        format: uuid
      • cycleId
        string
        required
        format: uuid
      • sequence
        integer
        required
        minimum: 0
      • action
        activate
        or
        pause
        or
        resume
        or
        reset
        or
        complete
        or
        end_early
        +1 more
        required
      • previousStatus
        planning
        or
        locked
        or
        active
        or
        resolution_open
        or
        closed
        or
        paused
        +4 more
        required
      • resultingStatus
        planning
        or
        locked
        or
        active
        or
        resolution_open
        or
        closed
        or
        paused
        +4 more
        required
      • reason
        string
        required
        maxLength: 2000 · minLength: 1
      • expectedRestartAt
        string
        or null
        required
        format: date-time
      • previousPrimaryOutcome
        string
        required
        maxLength: 4000 · minLength: 1
      • resultingPrimaryOutcome
        string
        required
        maxLength: 4000 · minLength: 1
      • actorUserId
        string
        required
        minLength: 1
      • createdAt
        string
        required
        format: date-time
    • seasonReview
      object
      or null
      required
      • id
        string
        required
        format: uuid
      • entityId
        string
        required
        format: uuid
      • cycleId
        string
        required
        format: uuid
      • completionEventId
        string
        required
        format: uuid
      • snapshot
        object
        required
        • schemaVersion
          1
          required
        • cycleId
          string
          required
          format: uuid
        • entityId
          string
          required
          format: uuid
        • completionEventId
          string
          required
          format: uuid
        • completedAt
          string
          required
          format: date-time
        • originalBaseline
          object
          required
          • baselineId
            string
            required
            format: uuid
          • versionNumber
            integer
            required
            minimum: 0
          • snapshotHash
            string
            required
            pattern: ^sha256:[a-f0-9]{64}$
          • snapshot
            map of
            unknown
            required
        • target
          object
          required
          • original
            string
            required
            maxLength: 4000 · minLength: 1
          • final
            string
            required
            maxLength: 4000 · minLength: 1
        • route
          object
          required
          • phases
            array of
            object
            required
            • id
              string
              required
              format: uuid
            • title
              string
              required
              minLength: 1
            • startsAt
              string
              or null
              required
              format: date-time
            • endsAt
              string
              required
              format: date-time
          • milestones
            array of
            object
            required
            • id
              string
              required
              format: uuid
            • title
              string
              required
              minLength: 1
            • startsAt
              string
              or null
              required
              format: date-time
            • endsAt
              string
              required
              format: date-time
          • materialChanges
            array of
            object
            required
            • kind
              lifecycle
              or
              calendar_reschedule
              or
              commitment_edit
              or
              commitment_reset
              required
            • sourceId
              string
              required
              format: uuid
            • occurredAt
              string
              required
              format: date-time
            • reason
              string
              required
              maxLength: 4000 · minLength: 1
        • commitments
          array of
          object
          required
          • commitmentId
            string
            required
            format: uuid
          • title
            string
            required
            minLength: 1
          • ownerUserId
            string
            or null
            required
            minLength: 1
          • weekStart
            string
            or null
            required
            format: date-time
          • deadlineAt
            string
            or null
            required
            format: date-time
          • baselineValue
            number
            or null
            required
          • targetValue
            number
            or null
            required
          • measurementUnit
            string
            or null
            required
          • plannedPayloadHash
            string
            or null
            required
            pattern: ^sha256:[a-f0-9]{64}$
          • outcome
            object
            or null
            required
            • status
              completed
              or
              partial
              or
              missed
              required
            • actualValue
              number
              or null
              required
            • actualResult
              string
              required
              maxLength: 4000 · minLength: 1
            • varianceExplanation
              string
              or null
              required
              maxLength: 4000 · minLength: 1
            • resolvedAt
              string
              required
              format: date-time
            • payloadHash
              string
              required
              pattern: ^sha256:[a-f0-9]{64}$
          • truthStatus
            resolved
            or
            missing_outcome
            required
        • evidenceCoverage
          object
          required
          • artifactBacked
            integer
            required
            minimum: 0
          • sourceVerified
            integer
            required
            minimum: 0
          • thirdPartyAttested
            integer
            required
            minimum: 0
          • commitmentsWithoutEvidence
            integer
            required
            minimum: 0
        • assumptions
          array of
          object
          required
          • statement
            string
            required
            minLength: 1
          • assessment
            unassessed
            required
        • weeklyReviews
          object
          required
          • filed
            array of
            object
            required
            • reviewId
              string
              required
              format: uuid
            • periodStart
              string
              required
              format: date-time
            • periodEndExclusive
              string
              required
              format: date-time
            • learning
              string
              required
              maxLength: 4000 · minLength: 1
            • nextPlan
              string
              required
              maxLength: 4000 · minLength: 1
            • filedAt
              string
              required
              format: date-time
            • sourceHash
              string
              required
              pattern: ^sha256:[a-f0-9]{64}$
          • missingPeriods
            array of
            object
            required
            • periodStart
              string
              required
              format: date-time
            • periodEndExclusive
              string
              required
              format: date-time
        • learned
          array of
          string
          required
          maxLength: 4000 · minLength: 1
        • next
          array of
          string
          required
          maxLength: 4000 · minLength: 1
        • founderAttestation
          string
          required
          maxLength: 4000 · minLength: 1
        • thirdPartyAttestations
          array of
          object
          required
          • evidenceId
            string
            required
            format: uuid
          • attestorUserId
            string
            required
            minLength: 1
          • attestationScope
            required

            Any of the following:

            • object
              • status
                complete
                required
              • observed
                string
                required
                maxLength: 4000 · minLength: 1
              • notVerified
                string
                required
                maxLength: 4000 · minLength: 1
            • object
              • status
                legacy_incomplete
                required
              • legacyStatement
                string
                required
                maxLength: 4000 · minLength: 1
          • recordedAt
            string
            required
            format: date-time
          • sourceHash
            string
            required
            pattern: ^sha256:[a-f0-9]{64}$
        • visibility
          public
          or
          follower
          or
          capital
          or
          diligence
          or
          custom
          required
      • sourceHash
        string
        required
        pattern: ^sha256:[a-f0-9]{64}$
      • reviewHash
        string
        required
        pattern: ^sha256:[a-f0-9]{64}$
      • founderAttestation
        string
        required
        maxLength: 4000 · minLength: 1
      • visibility
        public
        or
        follower
        or
        capital
        or
        diligence
        or
        custom
        required
      • generatedBy
        string
        required
        minLength: 1
      • generatedAt
        string
        required
        format: date-time
      • createdAt
        string
        required
        format: date-time
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

409

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

422

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

429

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

502

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

503

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close