---
title: "Get access"
---

> 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}/access`

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/reports/<id>/access';
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>/access"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "string",
      "resourceType": "string",
      "resourceId": "string",
      "grantedToUserId": "string",
      "grantedById": "string",
      "permission": "read",
      "createdAt": "string",
      "updatedAt": "string",
      "grantedUser": {
        "id": "string",
        "name": "string",
        "email": "string",
        "avatar": "string",
        "title": "string"
      }
    }
  ],
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`report-get-access.response.200.data`; array<object>, required)
  - `id` (`report-get-access.response.200.data.id`; string, required)
  - `resourceType` (`report-get-access.response.200.data.resourceType`; string, required)
  - `resourceId` (`report-get-access.response.200.data.resourceId`; string, required)
  - `grantedToUserId` (`report-get-access.response.200.data.grantedToUserId`; string, required)
  - `grantedById` (`report-get-access.response.200.data.grantedById`; string, required)
  - `permission` (`report-get-access.response.200.data.permission`; string, required)
    - one of `"read"`, `"write"`, `"admin"`
  - `createdAt` (`report-get-access.response.200.data.createdAt`; string, required)
  - `updatedAt` (`report-get-access.response.200.data.updatedAt`; string, required)
  - `grantedUser` (`report-get-access.response.200.data.grantedUser`; object, optional, nullable)
    - `id` (`report-get-access.response.200.data.grantedUser.id`; string, required, nullable)
    - `name` (`report-get-access.response.200.data.grantedUser.name`; string, required, nullable)
    - `email` (`report-get-access.response.200.data.grantedUser.email`; string, required, nullable)
    - `avatar` (`report-get-access.response.200.data.grantedUser.avatar`; string, required, nullable)
    - `title` (`report-get-access.response.200.data.grantedUser.title`; string, required, nullable)
- `meta` (`report-get-access.response.200.meta`; object, optional)
  - `timestamp` (`report-get-access.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-access.response.400.error`; object, required)
  - `code` (`report-get-access.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-access.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-access.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-access.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-access.response.401.error`; object, required)
  - `code` (`report-get-access.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-access.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-access.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-access.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-access.response.403.error`; object, required)
  - `code` (`report-get-access.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-access.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-access.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-access.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-access.response.404.error`; object, required)
  - `code` (`report-get-access.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-access.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-access.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-access.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-access.response.500.error`; object, required)
  - `code` (`report-get-access.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-access.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-access.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-access.response.500.error.traceId`; string, optional) — Unique ID for log correlation


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