Skip to content
Navigation

Get access

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

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    array of
    object
    required
    • id
      string
      required
    • resourceType
      string
      required
    • resourceId
      string
      required
    • grantedToUserId
      string
      required
    • grantedById
      string
      required
    • permission
      read
      or
      write
      or
      admin
      required
    • createdAt
      string
      required
    • updatedAt
      string
      required
    • grantedUser
      optional
      object
      or null
      • id
        string
        or null
        required
      • name
        string
        or null
        required
      • email
        string
        or null
        required
      • avatar
        string
        or null
        required
      • title
        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