Get shared with me

GET

https://api.sureshake.com/v2/reports/shared-with-me

Query parameters

limit
optional
number
maximum: 100 · minimum: 1 · default: 20

offset
optional
number
minimum: 0 · default: 0
status
optional
accepted

Returns

200

Default Response

JSON

data
object
required
- items
  array of
  required
  Any of the following:
  object
  id
  string
  required
  format: uuid
  reportId
  string
  required
  format: uuid
  versionId
  string
  required
  format: uuid
  sharedByUserId
  string
  required
  permission
  read
  or
  comment
  or
  suggest
  required
  message
  string
  or null
  required
  createdAt
  string
  required
  viewedAt
  string
  or null
  required
  isUnread
  boolean
  required
  relationState
  complete
  required
  unavailableRelations
  array of
  unknown
  required
  reportTitle
  string
  required
  reportType
  string
  or null
  required
  entityName
  string
  or null
  required
  versionNumber
  number
  required
  documentType
  string
  or null
  required
  sharedByName
  string
  or null
  required
  sharedByEmail
  string
  or null
  required
  sharedByAvatar
  string
  or null
  required
  withdrawnAt
  optional
  string
  or null
  format: date-time
  object
  id
  string
  required
  format: uuid
  reportId
  string
  required
  format: uuid
  versionId
  string
  required
  format: uuid
  sharedByUserId
  string
  required
  permission
  read
  or
  comment
  or
  suggest
  required
  message
  string
  or null
  required
  createdAt
  string
  required
  viewedAt
  string
  or null
  required
  isUnread
  boolean
  required
  relationState
  unavailable
  required
  unavailableRelations
  array of
  report
  or
  report_version
  or
  sharer_user
  required
  reportTitle
  string
  or null
  required
  reportType
  string
  or null
  required
  entityName
  string
  or null
  required
  versionNumber
  number
  or null
  required
  documentType
  string
  or null
  required
  sharedByName
  string
  or null
  required
  sharedByEmail
  string
  or null
  required
  sharedByAvatar
  string
  or null
  required
  withdrawnAt
  optional
  string
  or null
  format: date-time
- total
  number
  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
}