List vouches

GET

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

Path parameters

entityId
string
required
format: uuid

Query parameters

includeInactive
optional
boolean
default: false

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- subjectEntityId
  string
  required
  format: uuid
- voucherEntityId
  string
  required
  format: uuid
- voucherEntityName
  string
  required
- scope
  string
  required
- confidence
  integer
  required
- status
  string
  required
- evidenceHash
  string
  or null
  required
- evidenceCid
  string
  or null
  required
- comment
  string
  or null
  required
- expiresAt
  string
  or null
  required
  format: date-time
- revokedAt
  string
  or null
  required
  format: date-time
- revokedReason
  string
  or null
  required
- createdBy
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- voucherOverallScore
  number
  or null
  required
- weightedContribution
  number
  required
}
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", "subjectEntityId": "4b061bab-22ab-4502-88c3-80c49638a133", "voucherEntityId": "687a822d-209a-4607-9d86-54cce0292c95", "voucherEntityName": "string", "scope": "string", "confidence": 0, "status": "string", "evidenceHash": "string", "evidenceCid": "string", "comment": "string", "expiresAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "revokedReason": "string", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "voucherOverallScore": 0, "weightedContribution": 0 } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }