List research details

GET

https://api.aventure.vc/v1/entities/:entityId/research/details

GET

/v1/entities/:entityId/research/details

$ curl -G https://api.aventure.vc/v1/entities/04e2bf9c-a100-72ad-83ff-ba69c647b30b/research/details \
>      -H "Authorization: Bearer <token>" \
>      -d page=0 \
>      -d size=25 \
>      -d type=nameCongruencyScore

1 {
2   "content": [
3     {
4       "entityId": "string",
5       "id": 1,
6       "typeResearchDetail": "string",
7       "valueType": "text",
8       "asOfDate": "2024-01-15T09:30:00Z",
9       "createdAt": "2024-01-15T09:30:00Z",
10       "creator": "string",
11       "dataConfidence": "low",
12       "derivedRange": {
13         "asOfDate": "2024-01-15T09:30:00Z",
14         "bucket": "pastDue",
15         "monthsFromNow": 1,
16         "targetDate": "2024-01-15T09:30:00Z"
17       },
18       "discreteValue": 1.1,
19       "textValue": "string",
20       "updatedAt": "2024-01-15T09:30:00Z",
21       "valueResearchDetail": "string"
22     }
23   ],
24   "empty": true,
25   "first": true,
26   "last": true,
27   "number": 1,
28   "numberOfElements": 1,
29   "pageable": {
30     "offset": 1,
31     "pageNumber": 1,
32     "pageSize": 1,
33     "paged": true,
34     "sort": {
35       "empty": true,
36       "sorted": true,
37       "unsorted": true
38     },
39     "unpaged": true
40   },
41   "size": 1,
42   "sort": {
43     "empty": true,
44     "sorted": true,
45     "unsorted": true
46   },
47   "totalElements": 1,
48   "totalPages": 1
49 }

Returns paginated research details for an entity. Optionally filter by detail type. Rows for timeSeries=true types are history, not stale current state.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

X-API-Keystring

Admin API key for system-to-system write operations

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Path parameters

entityIdstringRequiredformat: "uuid"

Canonical entity UUID.

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page index (0..N)

sizeintegerOptionalDefaults to 25

The size of the page to be returned

sortlist of stringsOptional

Sorting is not supported

typestringOptional

Research detail type filter.

Response

contentlist of objectsOptional

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberintegerOptional

numberOfElementsintegerOptional

pageableobjectOptional

sizeintegerOptional

sortobjectOptional

totalElementslongOptional

totalPagesintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error