Skip to content
Navigation

Get my share for report

GET
https://api.sureshake.com/v2/reports/{id}/my-share

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    or null
    required

    Any of the following:

    • object
      • shareId
        string
        required
        format: uuid
      • reportId
        string
        required
        format: uuid
      • reportVersionId
        string
        required
        format: uuid
      • permission
        read
        or
        comment
        or
        suggest
        required
      • shareType
        connection
        or
        email_invite
        required
      • relationState
        complete
        required
      • unavailableRelations
        array of
        unknown
        required
      • reportVersionNumber
        number
        required
      • reportVersionStatus
        string
        required
    • object
      • shareId
        string
        required
        format: uuid
      • reportId
        string
        required
        format: uuid
      • reportVersionId
        string
        required
        format: uuid
      • permission
        read
        or
        comment
        or
        suggest
        required
      • shareType
        connection
        or
        email_invite
        required
      • relationState
        unavailable
        required
      • unavailableRelations
        array of
        unknown
        required
      • reportVersionNumber
        null
        or null
        required
      • reportVersionStatus
        null
        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