---
title: "Get report shares"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › reports

`GET /v2/reports/{id}/shares`

## Path parameters

- `id` (`report-get-report-shares.path.id`; string, required)
  - format `uuid`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/reports/<id>/shares'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/reports/<id>/shares';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/reports/<id>/shares"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "shares": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
        "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
        "sharedWithUserId": "string",
        "sharedWithEmail": "string",
        "shareType": "connection",
        "status": "pending",
        "permission": "read",
        "allowDownload": true,
        "watermark": true,
        "message": "string",
        "viewCount": 0,
        "viewCountSemantics": "rolling_90_day",
        "viewCountPeriod": {
          "asOf": "2019-08-24T14:15:22Z",
          "cutoffAt": "2019-08-24T14:15:22Z",
          "retentionDays": 90,
          "timezone": "UTC"
        },
        "hasBeenViewed": true,
        "expiresAt": "string",
        "createdAt": "string",
        "viewedAt": "string",
        "lastViewedAt": "string",
        "relationState": "complete",
        "unavailableRelations": [],
        "reportTitle": "string",
        "versionNumber": 0,
        "versionStatus": "string",
        "sharedWithName": "string",
        "sharedWithAvatar": "string"
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`report-get-report-shares.response.200.data`; object, required)
  - `shares` (`report-get-report-shares.response.200.data.shares`; array<any of>, required)
    - any of:
      - `object`
        - `id` (`report-get-report-shares.response.200.data.shares.1.id`; string, required)
          - format `uuid`
        - `reportId` (`report-get-report-shares.response.200.data.shares.1.reportId`; string, required)
          - format `uuid`
        - `versionId` (`report-get-report-shares.response.200.data.shares.1.versionId`; string, required)
          - format `uuid`
        - `sharedWithUserId` (`report-get-report-shares.response.200.data.shares.1.sharedWithUserId`; string, required, nullable)
        - `sharedWithEmail` (`report-get-report-shares.response.200.data.shares.1.sharedWithEmail`; string, required, nullable)
        - `shareType` (`report-get-report-shares.response.200.data.shares.1.shareType`; string, required)
          - one of `"connection"`, `"email_invite"`
        - `status` (`report-get-report-shares.response.200.data.shares.1.status`; string, required)
          - one of `"pending"`, `"accepted"`, `"revoked"`, `"expired"`
        - `permission` (`report-get-report-shares.response.200.data.shares.1.permission`; string, required)
          - one of `"read"`, `"comment"`, `"suggest"`
        - `allowDownload` (`report-get-report-shares.response.200.data.shares.1.allowDownload`; boolean, required, nullable)
        - `watermark` (`report-get-report-shares.response.200.data.shares.1.watermark`; boolean, required, nullable)
        - `message` (`report-get-report-shares.response.200.data.shares.1.message`; string, required, nullable)
        - `viewCount` (`report-get-report-shares.response.200.data.shares.1.viewCount`; number, required)
        - `viewCountSemantics` (`report-get-report-shares.response.200.data.shares.1.viewCountSemantics`; string, required)
          - one of `"rolling_90_day"`
        - `viewCountPeriod` (`report-get-report-shares.response.200.data.shares.1.viewCountPeriod`; object, required)
          - `asOf` (`report-get-report-shares.response.200.data.shares.1.viewCountPeriod.asOf`; string, required)
            - format `date-time`
          - `cutoffAt` (`report-get-report-shares.response.200.data.shares.1.viewCountPeriod.cutoffAt`; string, required)
            - format `date-time`
          - `retentionDays` (`report-get-report-shares.response.200.data.shares.1.viewCountPeriod.retentionDays`; number, required)
            - one of `90`
          - `timezone` (`report-get-report-shares.response.200.data.shares.1.viewCountPeriod.timezone`; string, required)
            - one of `"UTC"`
        - `hasBeenViewed` (`report-get-report-shares.response.200.data.shares.1.hasBeenViewed`; boolean, required)
        - `expiresAt` (`report-get-report-shares.response.200.data.shares.1.expiresAt`; string, required, nullable)
        - `createdAt` (`report-get-report-shares.response.200.data.shares.1.createdAt`; string, required)
        - `viewedAt` (`report-get-report-shares.response.200.data.shares.1.viewedAt`; string, required, nullable)
        - `lastViewedAt` (`report-get-report-shares.response.200.data.shares.1.lastViewedAt`; string, required, nullable)
        - `relationState` (`report-get-report-shares.response.200.data.shares.1.relationState`; string, required)
          - one of `"complete"`
        - `unavailableRelations` (`report-get-report-shares.response.200.data.shares.1.unavailableRelations`; array<unknown>, required)
        - `reportTitle` (`report-get-report-shares.response.200.data.shares.1.reportTitle`; string, required)
        - `versionNumber` (`report-get-report-shares.response.200.data.shares.1.versionNumber`; number, required)
        - `versionStatus` (`report-get-report-shares.response.200.data.shares.1.versionStatus`; string, required)
        - `sharedWithName` (`report-get-report-shares.response.200.data.shares.1.sharedWithName`; string, required, nullable)
        - `sharedWithAvatar` (`report-get-report-shares.response.200.data.shares.1.sharedWithAvatar`; string, required, nullable)
      - `object`
        - `id` (`report-get-report-shares.response.200.data.shares.2.id`; string, required)
          - format `uuid`
        - `reportId` (`report-get-report-shares.response.200.data.shares.2.reportId`; string, required)
          - format `uuid`
        - `versionId` (`report-get-report-shares.response.200.data.shares.2.versionId`; string, required)
          - format `uuid`
        - `sharedWithUserId` (`report-get-report-shares.response.200.data.shares.2.sharedWithUserId`; string, required, nullable)
        - `sharedWithEmail` (`report-get-report-shares.response.200.data.shares.2.sharedWithEmail`; string, required, nullable)
        - `shareType` (`report-get-report-shares.response.200.data.shares.2.shareType`; string, required)
          - one of `"connection"`, `"email_invite"`
        - `status` (`report-get-report-shares.response.200.data.shares.2.status`; string, required)
          - one of `"pending"`, `"accepted"`, `"revoked"`, `"expired"`
        - `permission` (`report-get-report-shares.response.200.data.shares.2.permission`; string, required)
          - one of `"read"`, `"comment"`, `"suggest"`
        - `allowDownload` (`report-get-report-shares.response.200.data.shares.2.allowDownload`; boolean, required, nullable)
        - `watermark` (`report-get-report-shares.response.200.data.shares.2.watermark`; boolean, required, nullable)
        - `message` (`report-get-report-shares.response.200.data.shares.2.message`; string, required, nullable)
        - `viewCount` (`report-get-report-shares.response.200.data.shares.2.viewCount`; number, required)
        - `viewCountSemantics` (`report-get-report-shares.response.200.data.shares.2.viewCountSemantics`; string, required)
          - one of `"rolling_90_day"`
        - `viewCountPeriod` (`report-get-report-shares.response.200.data.shares.2.viewCountPeriod`; object, required)
          - `asOf` (`report-get-report-shares.response.200.data.shares.2.viewCountPeriod.asOf`; string, required)
            - format `date-time`
          - `cutoffAt` (`report-get-report-shares.response.200.data.shares.2.viewCountPeriod.cutoffAt`; string, required)
            - format `date-time`
          - `retentionDays` (`report-get-report-shares.response.200.data.shares.2.viewCountPeriod.retentionDays`; number, required)
            - one of `90`
          - `timezone` (`report-get-report-shares.response.200.data.shares.2.viewCountPeriod.timezone`; string, required)
            - one of `"UTC"`
        - `hasBeenViewed` (`report-get-report-shares.response.200.data.shares.2.hasBeenViewed`; boolean, required)
        - `expiresAt` (`report-get-report-shares.response.200.data.shares.2.expiresAt`; string, required, nullable)
        - `createdAt` (`report-get-report-shares.response.200.data.shares.2.createdAt`; string, required)
        - `viewedAt` (`report-get-report-shares.response.200.data.shares.2.viewedAt`; string, required, nullable)
        - `lastViewedAt` (`report-get-report-shares.response.200.data.shares.2.lastViewedAt`; string, required, nullable)
        - `relationState` (`report-get-report-shares.response.200.data.shares.2.relationState`; string, required)
          - one of `"unavailable"`
        - `unavailableRelations` (`report-get-report-shares.response.200.data.shares.2.unavailableRelations`; array<string>, required)
          - one of `"report"`, `"report_version"`, `"recipient_user"`
        - `reportTitle` (`report-get-report-shares.response.200.data.shares.2.reportTitle`; string, required, nullable)
        - `versionNumber` (`report-get-report-shares.response.200.data.shares.2.versionNumber`; number, required, nullable)
        - `versionStatus` (`report-get-report-shares.response.200.data.shares.2.versionStatus`; string, required, nullable)
        - `sharedWithName` (`report-get-report-shares.response.200.data.shares.2.sharedWithName`; string, required, nullable)
        - `sharedWithAvatar` (`report-get-report-shares.response.200.data.shares.2.sharedWithAvatar`; string, required, nullable)
- `meta` (`report-get-report-shares.response.200.meta`; object, optional)
  - `timestamp` (`report-get-report-shares.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-report-shares.response.400.error`; object, required)
  - `code` (`report-get-report-shares.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-report-shares.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-report-shares.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-report-shares.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-report-shares.response.401.error`; object, required)
  - `code` (`report-get-report-shares.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-report-shares.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-report-shares.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-report-shares.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-report-shares.response.403.error`; object, required)
  - `code` (`report-get-report-shares.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-report-shares.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-report-shares.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-report-shares.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-report-shares.response.404.error`; object, required)
  - `code` (`report-get-report-shares.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-report-shares.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-report-shares.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-report-shares.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-report-shares.response.500.error`; object, required)
  - `code` (`report-get-report-shares.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-report-shares.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-report-shares.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-report-shares.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/report-get-report-shares/index.md