Get calendar

GET

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

Path parameters

cycleId
string
required
format: uuid

Query parameters

view
today
or
week
or
month
or
season
required
timeZone
string
required
maxLength: 100 · minLength: 1
anchorDate
optional
string
pattern: ^\d{4}-\d{2}-\d{2}$

Returns

200

Default Response

JSON

data
object
required
- cycleId
  string
  required
  format: uuid
- view
  today
  or
  week
  or
  month
  or
  season
  required
- anchorDate
  string
  or null
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- timeZone
  string
  required
  minLength: 1
- rangeStart
  string
  required
  format: date-time
- rangeEndExclusive
  string
  required
  format: date-time
- items
  array of
  object
  required
  sourceType
  milestone
  or
  commitment
  required
  sourceId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  title
  string
  required
  originalOccursAt
  string
  required
  format: date-time
  occursAt
  string
  required
  format: date-time
  status
  string
  or null
  required
  minLength: 1
  calendarStatus
  scheduled
  or
  in_progress
  or
  completed
  or
  partial
  or
  missed
  or
  reset
  +2 more
  required
  phaseId
  string
  or null
  required
  format: uuid
  commitment
  object
  or null
  required
  ownerUserId
  string
  required
  minLength: 1
  completionDefinition
  string
  required
  maxLength: 2000 · minLength: 1
  proofStandard
  string
  required
  maxLength: 2000 · minLength: 1
  baselineValue
  number
  or null
  required
  targetValue
  number
  or null
  required
  measurementUnit
  string
  or null
  required
  maxLength: 100 · minLength: 1
  expectedEffortMinutes
  integer
  or null
  required
  maximum: 10080 · minimum: 1
  dependencies
  array of
  string
  required
  maxLength: 500 · minLength: 1
  risks
  array of
  string
  required
  maxLength: 500 · minLength: 1
  qualityWarnings
  array of
  object
  required
  code
  activity_based
  or
  not_objectively_closeable
  required
  message
  string
  required
  maxLength: 500 · minLength: 1
  fields
  array of
  outcome
  or
  completionDefinition
  or
  proofStandard
  required
  qualityAssessedAt
  string
  or null
  required
  format: date-time
  currentVersionNumber
  integer
  required
  minimum: 1
  closure
  object
  or null
  required
  id
  string
  required
  format: uuid
  commitmentId
  string
  required
  format: uuid
  outcomeStatus
  completed
  or
  partial
  or
  missed
  required
  actualResult
  string
  required
  maxLength: 4000 · minLength: 1
  varianceExplanation
  string
  or null
  required
  maxLength: 4000 · minLength: 1
  commitmentVersionNumber
  integer
  required
  minimum: 1
  resolvedBy
  string
  required
  minLength: 1
  resolvedAt
  string
  required
  format: date-time
  payloadHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  followerUpdate
  object
  required
  selected
  boolean
  required
  updateId
  string
  or null
  required
  format: uuid
  selectedBy
  string
  or null
  required
  minLength: 1
  selectedAt
  string
  or null
  required
  format: date-time
  resetLineage
  object
  required
  previous
  object
  or null
  required
  resetId
  string
  required
  format: uuid
  originalCommitmentId
  string
  required
  format: uuid
  replacementCommitmentId
  string
  required
  format: uuid
  originalVersionNumber
  integer
  required
  minimum: 1
  reason
  string
  required
  maxLength: 4000 · minLength: 1
  resetBy
  string
  required
  minLength: 1
  resetAt
  string
  required
  format: date-time
  payloadHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  next
  object
  or null
  required
  resetId
  string
  required
  format: uuid
  originalCommitmentId
  string
  required
  format: uuid
  replacementCommitmentId
  string
  required
  format: uuid
  originalVersionNumber
  integer
  required
  minimum: 1
  reason
  string
  required
  maxLength: 4000 · minLength: 1
  resetBy
  string
  required
  minLength: 1
  resetAt
  string
  required
  format: date-time
  payloadHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  evidenceStatus
  required
  Any of the following:
  object
  state
  missing
  required
  commitmentVersionNumber
  integer
  required
  minimum: 1
  evidenceCount
  0
  required
  basis
  persisted_evidence_records
  required
  object
  state
  present
  required
  commitmentVersionNumber
  integer
  required
  minimum: 1
  evidenceCount
  integer
  required
  minimum: 1
  basis
  persisted_evidence_records
  required
  evidence
  array of
  required
  Any of the following:
  object
  id
  string
  required
  format: uuid
  commitmentId
  string
  required
  format: uuid
  commitmentVersionNumber
  integer
  required
  minimum: 1
  resolutionId
  string
  or null
  required
  format: uuid
  displayName
  string
  required
  maxLength: 500 · minLength: 1
  ownerEntityId
  string
  required
  format: uuid
  effectiveAt
  string
  required
  format: date-time
  visibility
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  recordedBy
  string
  required
  minLength: 1
  sourceHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  createdAt
  string
  required
  format: date-time
  sourceKind
  upload
  required
  verificationStatus
  artifact_backed
  required
  artifactId
  string
  required
  format: uuid
  reference
  optional
  Any of the following:
  object
  type
  page
  required
  page
  integer
  required
  minimum: 1
  pageEnd
  optional
  integer
  minimum: 1
  object
  type
  section
  required
  section
  string
  required
  maxLength: 500 · minLength: 1
  object
  type
  object
  required
  objectType
  string
  required
  maxLength: 200 · minLength: 1
  objectId
  string
  required
  maxLength: 1000 · minLength: 1
  invitation
  optional
  unknown
  object
  id
  string
  required
  format: uuid
  commitmentId
  string
  required
  format: uuid
  commitmentVersionNumber
  integer
  required
  minimum: 1
  resolutionId
  string
  or null
  required
  format: uuid
  displayName
  string
  required
  maxLength: 500 · minLength: 1
  ownerEntityId
  string
  required
  format: uuid
  effectiveAt
  string
  required
  format: date-time
  visibility
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  recordedBy
  string
  required
  minLength: 1
  sourceHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  createdAt
  string
  required
  format: date-time
  sourceKind
  sureshake_link
  required
  verificationStatus
  artifact_backed
  required
  resourceType
  report
  or
  artifact
  required
  resourceId
  string
  required
  format: uuid
  reference
  optional
  unknown
  invitation
  optional
  unknown
  object
  id
  string
  required
  format: uuid
  commitmentId
  string
  required
  format: uuid
  commitmentVersionNumber
  integer
  required
  minimum: 1
  resolutionId
  string
  or null
  required
  format: uuid
  displayName
  string
  required
  maxLength: 500 · minLength: 1
  ownerEntityId
  string
  required
  format: uuid
  effectiveAt
  string
  required
  format: date-time
  visibility
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  recordedBy
  string
  required
  minLength: 1
  sourceHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  createdAt
  string
  required
  format: date-time
  sourceKind
  integration
  required
  verificationStatus
  source_verified
  required
  integrationId
  string
  required
  format: uuid
  integrationKey
  string
  required
  minLength: 1
  resourceType
  string
  required
  maxLength: 200 · minLength: 1
  externalId
  string
  required
  maxLength: 1000 · minLength: 1
  contentHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  retrievedAt
  string
  required
  format: date-time
  reference
  optional
  unknown
  invitation
  optional
  unknown
  object
  id
  string
  required
  format: uuid
  commitmentId
  string
  required
  format: uuid
  commitmentVersionNumber
  integer
  required
  minimum: 1
  resolutionId
  string
  or null
  required
  format: uuid
  displayName
  string
  required
  maxLength: 500 · minLength: 1
  ownerEntityId
  string
  required
  format: uuid
  effectiveAt
  string
  required
  format: date-time
  visibility
  public
  or
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  recordedBy
  string
  required
  minLength: 1
  sourceHash
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  createdAt
  string
  required
  format: date-time
  sourceKind
  third_party_attestation
  required
  verificationStatus
  third_party_attested
  required
  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
  reference
  optional
  unknown
  invitation
  optional
  object
  id
  string
  required
  format: uuid
  relationship
  customer
  or
  mentor
  or
  advisor
  or
  program_operator
  or
  capital_provider
  required
  rescheduleHistory
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  sourceType
  milestone
  or
  commitment
  required
  sourceId
  string
  required
  format: uuid
  sequence
  integer
  required
  minimum: 0
  originalOccursAt
  string
  required
  format: date-time
  previousOccursAt
  string
  required
  format: date-time
  newOccursAt
  string
  required
  format: date-time
  reason
  string
  required
  maxLength: 2000 · minLength: 1
  rescheduledBy
  string
  required
  minLength: 1
  createdAt
  string
  required
  format: date-time
  links
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  sourceType
  milestone
  or
  commitment
  required
  sourceId
  string
  required
  format: uuid
  targetType
  initiative
  or
  report
  or
  artifact
  or
  external_object
  or
  meeting
  required
  resolution
  canonical
  or
  reference_only
  required
  targetRef
  string
  required
  maxLength: 500 · minLength: 1
  label
  string
  required
  maxLength: 500 · minLength: 1
  targetUrl
  string
  or null
  required
  format: uri
  active
  boolean
  required
  addedBy
  string
  required
  minLength: 1
  addedAt
  string
  required
  format: date-time
  removedBy
  string
  or null
  required
  minLength: 1
  removedAt
  string
  or null
  required
  format: date-time
  sharingPolicy
  object
  required
  policyVersionId
  string
  or null
  required
  format: uuid
  sequence
  integer
  required
  minimum: 0
  detailsVisibility
  private
  or
  season
  required
  outcomeVisibility
  private
  or
  season
  required
  reason
  string
  or null
  required
  maxLength: 2000 · minLength: 1
  changedBy
  string
  or null
  required
  minLength: 1
  changedAt
  string
  or null
  required
  format: date-time
  sharingPreview
  object
  required
  details
  object
  or null
  required
  title
  string
  required
  originalOccursAt
  string
  required
  format: date-time
  occursAt
  string
  required
  format: date-time
  phaseId
  string
  or null
  required
  format: uuid
  rescheduleHistory
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  sourceType
  milestone
  or
  commitment
  required
  sourceId
  string
  required
  format: uuid
  sequence
  integer
  required
  minimum: 0
  originalOccursAt
  string
  required
  format: date-time
  previousOccursAt
  string
  required
  format: date-time
  newOccursAt
  string
  required
  format: date-time
  reason
  string
  required
  maxLength: 2000 · minLength: 1
  rescheduledBy
  string
  required
  minLength: 1
  createdAt
  string
  required
  format: date-time
  links
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  sourceType
  milestone
  or
  commitment
  required
  sourceId
  string
  required
  format: uuid
  targetType
  initiative
  or
  report
  or
  artifact
  or
  external_object
  or
  meeting
  required
  resolution
  canonical
  or
  reference_only
  required
  targetRef
  string
  required
  maxLength: 500 · minLength: 1
  label
  string
  required
  maxLength: 500 · minLength: 1
  targetUrl
  string
  or null
  required
  format: uri
  active
  boolean
  required
  addedBy
  string
  required
  minLength: 1
  addedAt
  string
  required
  format: date-time
  removedBy
  string
  or null
  required
  minLength: 1
  removedAt
  string
  or null
  required
  format: date-time
  outcome
  object
  or null
  required
  calendarStatus
  scheduled
  or
  in_progress
  or
  completed
  or
  partial
  or
  missed
  or
  reset
  +2 more
  required
}
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
}