Get scores

GET

https://api.sureshake.com/v2/entities/{entityId}/scores

Path parameters

entityId
string
required
format: uuid

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- scoreType
  string
  required
- scoreValue
  string
  required
- scoreGrade
  string
  or null
  required
- calculatedAt
  string
  required
  format: date-time
- calculationMethod
  string
  or null
  required
- validUntil
  string
  or null
  required
  format: date-time
- confidenceLevel
  string
  or null
  required
- dataSources
  array of
  string
  or null
  required
- scoreFactors
  optional
  unknown
  or null
- metadata
  optional
  unknown
  or null
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

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
}

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
}

501

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
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "scoreType": "string", "scoreValue": "string", "scoreGrade": "string", "scoreFactors": null, "calculatedAt": "2019-08-24T14:15:22Z", "calculationMethod": "string", "validUntil": "2019-08-24T14:15:22Z", "confidenceLevel": "string", "dataSources": [ "string" ], "metadata": null } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }