---
title: "Get record summary"
---

> 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 › directory-public

`GET /v2/directory/{subjectType}/{slug}/record-summary`

## Authentication

Requires one of the following:

- 
- `BearerAuth`, http, header `Authorization`

## Path parameters

- `subjectType` (`directory-get-record-summary.path.subjectType`; string, required)
  - one of `"person"`, `"entity"`
- `slug` (`directory-get-record-summary.path.slug`; string, required)
  - minLength 1; maxLength 255

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/directory/person/<slug>/record-summary'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/person/<slug>/record-summary';
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/directory/person/<slug>/record-summary"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
    "subjectType": "person",
    "subjectId": "string",
    "claimStatus": "not_claimable",
    "verification": {
      "verified": true,
      "verifiedAt": "2019-08-24T14:15:22Z"
    },
    "reporting": {
      "reportsPublished": 0,
      "publicReports": 0,
      "reportingSince": "2019-08-24T14:15:22Z",
      "latestReportAt": "2019-08-24T14:15:22Z"
    },
    "followers": null,
    "reportIndex": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string",
        "publishedAt": "2019-08-24T14:15:22Z",
        "access": "public"
      }
    ],
    "viewer": {
      "following": true,
      "accessStatus": "none"
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`directory-get-record-summary.response.200.data`; object, required)
  - `listingId` (`directory-get-record-summary.response.200.data.listingId`; string, required)
    - format `uuid`
  - `subjectType` (`directory-get-record-summary.response.200.data.subjectType`; string, required)
    - one of `"person"`, `"entity"`
  - `subjectId` (`directory-get-record-summary.response.200.data.subjectId`; string, required, nullable)
  - `claimStatus` (`directory-get-record-summary.response.200.data.claimStatus`; string, required)
    - one of `"not_claimable"`, `"unclaimed"`, `"claim_pending"`, `"claimed"`
  - `verification` (`directory-get-record-summary.response.200.data.verification`; object, required)
    - `verified` (`directory-get-record-summary.response.200.data.verification.verified`; boolean, required)
    - `verifiedAt` (`directory-get-record-summary.response.200.data.verification.verifiedAt`; string, required, nullable)
      - format `date-time`
  - `reporting` (`directory-get-record-summary.response.200.data.reporting`; object, required)
    - `reportsPublished` (`directory-get-record-summary.response.200.data.reporting.reportsPublished`; integer, required)
      - min 0
    - `publicReports` (`directory-get-record-summary.response.200.data.reporting.publicReports`; integer, required)
      - min 0
    - `reportingSince` (`directory-get-record-summary.response.200.data.reporting.reportingSince`; string, required, nullable)
      - format `date-time`
    - `latestReportAt` (`directory-get-record-summary.response.200.data.reporting.latestReportAt`; string, required, nullable)
      - format `date-time`
  - `reportIndex` (`directory-get-record-summary.response.200.data.reportIndex`; array<object>, required)
    - `id` (`directory-get-record-summary.response.200.data.reportIndex.id`; string, required)
      - format `uuid`
    - `title` (`directory-get-record-summary.response.200.data.reportIndex.title`; string, required)
    - `publishedAt` (`directory-get-record-summary.response.200.data.reportIndex.publishedAt`; string, required)
      - format `date-time`
    - `access` (`directory-get-record-summary.response.200.data.reportIndex.access`; string, required)
      - one of `"public"`, `"permissioned"`
  - `viewer` (`directory-get-record-summary.response.200.data.viewer`; object, required, nullable) — Present only for authenticated callers
    - `following` (`directory-get-record-summary.response.200.data.viewer.following`; boolean, required)
    - `accessStatus` (`directory-get-record-summary.response.200.data.viewer.accessStatus`; string, required)
      - one of `"none"`, `"pending"`, `"active"`
  - `followers` (`directory-get-record-summary.response.200.data.followers`; unknown, optional)
- `meta` (`directory-get-record-summary.response.200.meta`; object, optional)
  - `timestamp` (`directory-get-record-summary.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

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

### 429

Default Response

#### Example

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

- `error` (`directory-get-record-summary.response.429.error`; object, required)
  - `code` (`directory-get-record-summary.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-record-summary.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-record-summary.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-record-summary.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` (`directory-get-record-summary.response.500.error`; object, required)
  - `code` (`directory-get-record-summary.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-record-summary.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-record-summary.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-record-summary.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` (`directory-get-record-summary.response.503.error`; object, required)
  - `code` (`directory-get-record-summary.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-record-summary.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-record-summary.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-record-summary.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-get-record-summary/index.md