List reporter report schedules

GET

https://api.sureshake.com/v2/reporter/report-schedules

Query parameters

entityId
string
required
format: uuid

includeDisabled
optional
boolean
default: false

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- reportingIntentId
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
- accountingConnectionId
  string
  required
  format: uuid
- createdByUserId
  string
  or null
  required
- name
  string
  required
  minLength: 1
- cadence
  monthly
  or
  quarterly
  or
  annual
  required
- runDayOffset
  integer
  required
  maximum: 60 · minimum: 0
- timezone
  string
  required
  maxLength: 64 · minLength: 1 · pattern: ^[A-Za-z_]+(?:\/[A-Za-z0-9_+-]+)*$
- enabled
  boolean
  required
- nextPeriodStart
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- nextPeriodEnd
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- nextRunAt
  string
  required
  format: date-time
- lastOccurrenceAt
  string
  or null
  required
  format: date-time
- distribution
  object
  required
  viewerGroupIds
  optional
  array of
  string
  format: uuid · default: []
  emails
  optional
  array of
  string
  format: email · default: []
  permission
  optional
  read
  or
  comment
  or
  suggest
  default: "read"
  message
  optional
  string
  maxLength: 1000
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

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
}

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
}