---
title: "Get reporter profile availability"
---

> 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}/reporter-profiles`

## Path parameters

- `id` (`entity-get-reporter-profile-availability.path.id`; string, required)
  - format `uuid`

## Query parameters

- `profileId` (`entity-get-reporter-profile-availability.query.profileId`; string, optional)
  - format `uuid`
- `sourceKey` (`entity-get-reporter-profile-availability.query.sourceKey`; string, optional)

## Code samples

### cURL

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

### TypeScript

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

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "entityType": "string",
    "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
    "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
    "sourceKey": "string",
    "profiles": [],
    "playbookAccess": {
      "isPremium": true,
      "canCreateDrafts": true,
      "canPreview": true,
      "canPublish": true
    },
    "sources": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "isConnected": true,
        "availableIntentKeys": [
          "string"
        ]
      }
    ],
    "intents": [
      {
        "key": "string",
        "label": "string",
        "description": "string",
        "sourceKeys": [],
        "isEnabled": true,
        "strategySummary": "string",
        "setupGuide": []
      }
    ],
    "status": "available"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`entity-get-reporter-profile-availability.response.200.data`; any of, required)
  - any of:
    - `object`
      - `entityId` (`entity-get-reporter-profile-availability.response.200.data.1.entityId`; string, required)
        - format `uuid`
      - `entityType` (`entity-get-reporter-profile-availability.response.200.data.1.entityType`; string, required)
      - `playbookAccess` (`entity-get-reporter-profile-availability.response.200.data.1.playbookAccess`; object, required)
        - `isPremium` (`entity-get-reporter-profile-availability.response.200.data.1.playbookAccess.isPremium`; boolean, required)
        - `canCreateDrafts` (`entity-get-reporter-profile-availability.response.200.data.1.playbookAccess.canCreateDrafts`; boolean, required)
        - `canPreview` (`entity-get-reporter-profile-availability.response.200.data.1.playbookAccess.canPreview`; boolean, required)
        - `canPublish` (`entity-get-reporter-profile-availability.response.200.data.1.playbookAccess.canPublish`; boolean, required)
      - `sources` (`entity-get-reporter-profile-availability.response.200.data.1.sources`; array<object>, required)
        - `key` (`entity-get-reporter-profile-availability.response.200.data.1.sources.key`; string, required)
        - `label` (`entity-get-reporter-profile-availability.response.200.data.1.sources.label`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.1.sources.description`; string, required)
        - `isConnected` (`entity-get-reporter-profile-availability.response.200.data.1.sources.isConnected`; boolean, required)
        - `availableIntentKeys` (`entity-get-reporter-profile-availability.response.200.data.1.sources.availableIntentKeys`; array<string>, required)
      - `intents` (`entity-get-reporter-profile-availability.response.200.data.1.intents`; array<object>, required)
        - `key` (`entity-get-reporter-profile-availability.response.200.data.1.intents.key`; string, required)
        - `label` (`entity-get-reporter-profile-availability.response.200.data.1.intents.label`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.1.intents.description`; string, required)
        - `sourceKeys` (`entity-get-reporter-profile-availability.response.200.data.1.intents.sourceKeys`; array<string>, optional)
          - default `[]`
        - `isEnabled` (`entity-get-reporter-profile-availability.response.200.data.1.intents.isEnabled`; boolean, optional)
          - default `true`
        - `strategySummary` (`entity-get-reporter-profile-availability.response.200.data.1.intents.strategySummary`; string, optional)
        - `setupGuide` (`entity-get-reporter-profile-availability.response.200.data.1.intents.setupGuide`; array<string>, optional)
          - default `[]`
      - `status` (`entity-get-reporter-profile-availability.response.200.data.1.status`; string, required)
        - one of `"available"`
      - `profileId` (`entity-get-reporter-profile-availability.response.200.data.1.profileId`; string, optional, nullable)
        - format `uuid`
      - `versionId` (`entity-get-reporter-profile-availability.response.200.data.1.versionId`; string, optional, nullable)
        - format `uuid`
      - `sourceKey` (`entity-get-reporter-profile-availability.response.200.data.1.sourceKey`; string, optional, nullable)
      - `profiles` (`entity-get-reporter-profile-availability.response.200.data.1.profiles`; array<object>, optional)
        - default `[]`
        - `id` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.id`; string, required)
          - format `uuid`
        - `name` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.name`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.description`; string, optional, nullable)
        - `origin` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.origin`; string, optional)
          - default `"custom"`
        - `marketplaceListingId` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.marketplaceListingId`; string, optional, nullable)
        - `marketplaceListingVersion` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.marketplaceListingVersion`; string, optional, nullable)
        - `publishedVersionId` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.publishedVersionId`; string, optional, nullable)
          - format `uuid`
        - `latestDraftVersionId` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.latestDraftVersionId`; string, optional, nullable)
          - format `uuid`
        - `defaultSourceKey` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.defaultSourceKey`; string, optional, nullable)
        - `defaultIntentKey` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.defaultIntentKey`; string, optional, nullable)
        - `enabledIntentKeys` (`entity-get-reporter-profile-availability.response.200.data.1.profiles.enabledIntentKeys`; array<string>, optional)
          - default `[]`
    - `object`
      - `entityId` (`entity-get-reporter-profile-availability.response.200.data.2.entityId`; string, required)
        - format `uuid`
      - `entityType` (`entity-get-reporter-profile-availability.response.200.data.2.entityType`; string, required)
      - `playbookAccess` (`entity-get-reporter-profile-availability.response.200.data.2.playbookAccess`; object, required)
        - `isPremium` (`entity-get-reporter-profile-availability.response.200.data.2.playbookAccess.isPremium`; boolean, required)
        - `canCreateDrafts` (`entity-get-reporter-profile-availability.response.200.data.2.playbookAccess.canCreateDrafts`; boolean, required)
        - `canPreview` (`entity-get-reporter-profile-availability.response.200.data.2.playbookAccess.canPreview`; boolean, required)
        - `canPublish` (`entity-get-reporter-profile-availability.response.200.data.2.playbookAccess.canPublish`; boolean, required)
      - `sources` (`entity-get-reporter-profile-availability.response.200.data.2.sources`; array<object>, required)
        - `key` (`entity-get-reporter-profile-availability.response.200.data.2.sources.key`; string, required)
        - `label` (`entity-get-reporter-profile-availability.response.200.data.2.sources.label`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.2.sources.description`; string, required)
        - `isConnected` (`entity-get-reporter-profile-availability.response.200.data.2.sources.isConnected`; boolean, required)
        - `availableIntentKeys` (`entity-get-reporter-profile-availability.response.200.data.2.sources.availableIntentKeys`; array<string>, required)
      - `intents` (`entity-get-reporter-profile-availability.response.200.data.2.intents`; array<object>, required)
        - `key` (`entity-get-reporter-profile-availability.response.200.data.2.intents.key`; string, required)
        - `label` (`entity-get-reporter-profile-availability.response.200.data.2.intents.label`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.2.intents.description`; string, required)
        - `sourceKeys` (`entity-get-reporter-profile-availability.response.200.data.2.intents.sourceKeys`; array<string>, optional)
          - default `[]`
        - `isEnabled` (`entity-get-reporter-profile-availability.response.200.data.2.intents.isEnabled`; boolean, optional)
          - default `true`
        - `strategySummary` (`entity-get-reporter-profile-availability.response.200.data.2.intents.strategySummary`; string, optional)
        - `setupGuide` (`entity-get-reporter-profile-availability.response.200.data.2.intents.setupGuide`; array<string>, optional)
          - default `[]`
      - `status` (`entity-get-reporter-profile-availability.response.200.data.2.status`; string, required)
        - one of `"unavailable"`
      - `reason` (`entity-get-reporter-profile-availability.response.200.data.2.reason`; string, required)
        - one of `"profile_store_unavailable"`
      - `message` (`entity-get-reporter-profile-availability.response.200.data.2.message`; string, required)
        - minLength 1
      - `profileId` (`entity-get-reporter-profile-availability.response.200.data.2.profileId`; string, optional, nullable)
        - format `uuid`
      - `versionId` (`entity-get-reporter-profile-availability.response.200.data.2.versionId`; string, optional, nullable)
        - format `uuid`
      - `sourceKey` (`entity-get-reporter-profile-availability.response.200.data.2.sourceKey`; string, optional, nullable)
      - `profiles` (`entity-get-reporter-profile-availability.response.200.data.2.profiles`; array<object>, optional)
        - default `[]`
        - `id` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.id`; string, required)
          - format `uuid`
        - `name` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.name`; string, required)
        - `description` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.description`; string, optional, nullable)
        - `origin` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.origin`; string, optional)
          - default `"custom"`
        - `marketplaceListingId` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.marketplaceListingId`; string, optional, nullable)
        - `marketplaceListingVersion` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.marketplaceListingVersion`; string, optional, nullable)
        - `publishedVersionId` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.publishedVersionId`; string, optional, nullable)
          - format `uuid`
        - `latestDraftVersionId` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.latestDraftVersionId`; string, optional, nullable)
          - format `uuid`
        - `defaultSourceKey` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.defaultSourceKey`; string, optional, nullable)
        - `defaultIntentKey` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.defaultIntentKey`; string, optional, nullable)
        - `enabledIntentKeys` (`entity-get-reporter-profile-availability.response.200.data.2.profiles.enabledIntentKeys`; array<string>, optional)
          - default `[]`
- `meta` (`entity-get-reporter-profile-availability.response.200.meta`; object, optional)
  - `timestamp` (`entity-get-reporter-profile-availability.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`entity-get-reporter-profile-availability.response.400.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.401.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.403.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.404.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.409.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.422.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.429.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.500.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.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-get-reporter-profile-availability.response.503.error`; object, required)
  - `code` (`entity-get-reporter-profile-availability.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-get-reporter-profile-availability.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`entity-get-reporter-profile-availability.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-get-reporter-profile-availability.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/entity-get-reporter-profile-availability/index.md