Get record summary

GET

https://api.sureshake.com/v2/directory/{subjectType}/{slug}/record-summary

Authorization

BearerAuth
optional
HTTP

Path parameters

subjectType
person
or
entity
required
slug
string
required
maxLength: 255 · minLength: 1

Returns

200

Default Response

JSON

data
object
required
- listingId
  string
  required
  format: uuid
- subjectType
  person
  or
  entity
  required
- subjectId
  string
  or null
  required
- claimStatus
  not_claimable
  or
  unclaimed
  or
  claim_pending
  or
  claimed
  required
- verification
  object
  required
  verified
  boolean
  required
  verifiedAt
  string
  or null
  required
  format: date-time
- reporting
  object
  required
  reportsPublished
  integer
  required
  minimum: 0
  publicReports
  integer
  required
  minimum: 0
  reportingSince
  string
  or null
  required
  format: date-time
  latestReportAt
  string
  or null
  required
  format: date-time
- reportIndex
  array of
  object
  required
  id
  string
  required
  format: uuid
  title
  string
  required
  publishedAt
  string
  required
  format: date-time
  access
  public
  or
  permissioned
  required
- viewer
  object
  or null
  required
  Present only for authenticated callers
  
  following
  boolean
  required
  accessStatus
  none
  or
  pending
  or
  active
  required
- followers
  optional
  unknown
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Get record summary

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

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));

Response example

{
  "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"
  }
}

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

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

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

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

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

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

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

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