List accessible reports

GET

https://api.sureshake.com/v2/entities/{id}/follow-access/reports

Path parameters

id
string
required
format: uuid

Query parameters

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

Returns

200

Default Response

JSON

reports
array of
object
required
- id
  string
  required
  format: uuid
- title
  string
  required
- description
  string
  or null
  required
- reportType
  string
  required
- status
  string
  required
- isPublic
  boolean
  required
- createdAt
  string
  required
- updatedAt
  string
  required
- fiscalPeriodStart
  string
  or null
  required
- fiscalPeriodEnd
  string
  or null
  required
- accessSource
  owner
  or
  entity_follow
  required
- entityId
  optional
  string
  or null
  format: uuid
- userId
  optional
  string
- currentVersionId
  optional
  string
  or null
  format: uuid
}

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
}

409

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
}

422

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
}

429

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
}

503

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
}

{ "reports": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "userId": "string", "title": "string", "description": "string", "reportType": "string", "status": "string", "isPublic": true, "currentVersionId": "7d3c5b66-ff6d-477a-9982-96f00519947f", "createdAt": "string", "updatedAt": "string", "fiscalPeriodStart": "string", "fiscalPeriodEnd": "string", "accessSource": "owner" } ] }