Skip to content
Navigation

Get report shares

GET
https://api.sureshake.com/v2/reports/{id}/shares

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • shares
      array of
      required

      Any of the following:

      • object
        • id
          string
          required
          format: uuid
        • reportId
          string
          required
          format: uuid
        • versionId
          string
          required
          format: uuid
        • sharedWithUserId
          string
          or null
          required
        • sharedWithEmail
          string
          or null
          required
        • shareType
          connection
          or
          email_invite
          required
        • status
          pending
          or
          accepted
          or
          revoked
          or
          expired
          required
        • permission
          read
          or
          comment
          or
          suggest
          required
        • allowDownload
          boolean
          or null
          required
        • watermark
          boolean
          or null
          required
        • message
          string
          or null
          required
        • viewCount
          number
          required
        • viewCountSemantics
          rolling_90_day
          required
        • viewCountPeriod
          object
          required
          • asOf
            string
            required
            format: date-time
          • cutoffAt
            string
            required
            format: date-time
          • retentionDays
            90
            required
          • timezone
            UTC
            required
        • hasBeenViewed
          boolean
          required
        • expiresAt
          string
          or null
          required
        • createdAt
          string
          required
        • viewedAt
          string
          or null
          required
        • lastViewedAt
          string
          or null
          required
        • relationState
          complete
          required
        • unavailableRelations
          array of
          unknown
          required
        • reportTitle
          string
          required
        • versionNumber
          number
          required
        • versionStatus
          string
          required
        • sharedWithName
          string
          or null
          required
        • sharedWithAvatar
          string
          or null
          required
      • object
        • id
          string
          required
          format: uuid
        • reportId
          string
          required
          format: uuid
        • versionId
          string
          required
          format: uuid
        • sharedWithUserId
          string
          or null
          required
        • sharedWithEmail
          string
          or null
          required
        • shareType
          connection
          or
          email_invite
          required
        • status
          pending
          or
          accepted
          or
          revoked
          or
          expired
          required
        • permission
          read
          or
          comment
          or
          suggest
          required
        • allowDownload
          boolean
          or null
          required
        • watermark
          boolean
          or null
          required
        • message
          string
          or null
          required
        • viewCount
          number
          required
        • viewCountSemantics
          rolling_90_day
          required
        • viewCountPeriod
          object
          required
          • asOf
            string
            required
            format: date-time
          • cutoffAt
            string
            required
            format: date-time
          • retentionDays
            90
            required
          • timezone
            UTC
            required
        • hasBeenViewed
          boolean
          required
        • expiresAt
          string
          or null
          required
        • createdAt
          string
          required
        • viewedAt
          string
          or null
          required
        • lastViewedAt
          string
          or null
          required
        • relationState
          unavailable
          required
        • unavailableRelations
          array of
          report
          or
          report_version
          or
          recipient_user
          required
        • reportTitle
          string
          or null
          required
        • versionNumber
          number
          or null
          required
        • versionStatus
          string
          or null
          required
        • sharedWithName
          string
          or null
          required
        • sharedWithAvatar
          string
          or null
          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

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

Type to search…

↑↓ navigate↵ selectEsc close