---
title: "List follow access policies"
---

> 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 › entities

`GET /v2/entities/{id}/follow-access/policies`

## Path parameters

- `id` (`entity-list-follow-access-policies.path.id`; string, required)
  - format `uuid`

## Query parameters

- `includeRevoked` (`entity-list-follow-access-policies.query.includeRevoked`; boolean, optional)
  - default `false`

## Code samples

### cURL

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

### TypeScript

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

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "principalType": "user",
    "principalId": "string",
    "status": "approved",
    "artifactPolicyMode": "all_reports",
    "allowedReportTypes": [
      "string"
    ],
    "allowedDocumentSourceTypes": [
      "string"
    ],
    "allowedTagIds": [
      "string"
    ],
    "allowedReportIds": [
      "string"
    ],
    "linkedArtifactAccess": "none",
    "profileAccessTier": "public",
    "allowedProfileFields": [
      "stage"
    ],
    "grantedByUserId": "string",
    "grantedAt": "string",
    "updatedAt": "string",
    "revokedAt": "string",
    "revocationReason": "string",
    "principal": {
      "property1": null,
      "property2": null
    }
  }
]
```

- `id` (`entity-list-follow-access-policies.response.200.id`; string, required)
  - format `uuid`
- `entityId` (`entity-list-follow-access-policies.response.200.entityId`; string, required)
  - format `uuid`
- `principalType` (`entity-list-follow-access-policies.response.200.principalType`; string, required)
  - one of `"user"`, `"entity"`, `"organization"`
- `principalId` (`entity-list-follow-access-policies.response.200.principalId`; string, required)
- `status` (`entity-list-follow-access-policies.response.200.status`; string, required)
  - one of `"approved"`, `"revoked"`
- `artifactPolicyMode` (`entity-list-follow-access-policies.response.200.artifactPolicyMode`; string, required)
  - one of `"all_reports"`, `"selector_based"`
- `allowedReportTypes` (`entity-list-follow-access-policies.response.200.allowedReportTypes`; array<string>, required)
- `allowedDocumentSourceTypes` (`entity-list-follow-access-policies.response.200.allowedDocumentSourceTypes`; array<string>, required)
- `allowedTagIds` (`entity-list-follow-access-policies.response.200.allowedTagIds`; array<string>, required)
- `allowedReportIds` (`entity-list-follow-access-policies.response.200.allowedReportIds`; array<string>, required)
- `linkedArtifactAccess` (`entity-list-follow-access-policies.response.200.linkedArtifactAccess`; string, required)
  - one of `"none"`, `"derived_only"`, `"full_artifact"`
- `profileAccessTier` (`entity-list-follow-access-policies.response.200.profileAccessTier`; string, required)
  - one of `"public"`, `"follower"`, `"capital"`, `"diligence"`, `"custom"`
- `allowedProfileFields` (`entity-list-follow-access-policies.response.200.allowedProfileFields`; array<string>, required)
  - one of `"stage"`, `"sector"`, `"geography"`, `"raiseStatus"`, `"tractionSummary"`, `"website"`, `"linkedinUrl"`, `"xHandle"`
- `grantedByUserId` (`entity-list-follow-access-policies.response.200.grantedByUserId`; string, required)
- `grantedAt` (`entity-list-follow-access-policies.response.200.grantedAt`; string, required)
- `updatedAt` (`entity-list-follow-access-policies.response.200.updatedAt`; string, required)
- `revokedAt` (`entity-list-follow-access-policies.response.200.revokedAt`; string, required, nullable)
- `revocationReason` (`entity-list-follow-access-policies.response.200.revocationReason`; string, required, nullable)
- `principal` (`entity-list-follow-access-policies.response.200.principal`; map<unknown>, required, nullable)

### 400

Default Response

#### Example

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

- `error` (`entity-list-follow-access-policies.response.400.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.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` (`entity-list-follow-access-policies.response.401.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.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` (`entity-list-follow-access-policies.response.403.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.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` (`entity-list-follow-access-policies.response.404.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

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

- `error` (`entity-list-follow-access-policies.response.409.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

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

- `error` (`entity-list-follow-access-policies.response.422.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

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

- `error` (`entity-list-follow-access-policies.response.429.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

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

### 503

Default Response

#### Example

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

- `error` (`entity-list-follow-access-policies.response.503.error`; object, required)
  - `code` (`entity-list-follow-access-policies.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-follow-access-policies.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-follow-access-policies.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-follow-access-policies.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/entity-list-follow-access-policies/index.md