List entity filter options

GET

https://api.aventure.vc/v1/entities/filters

GET

/v1/entities/filters

$ curl -G https://api.aventure.vc/v1/entities/filters \
>      -H "X-Client-Secret: <apiKey>" \
>      -d includeDistribution=false \
>      -d includePrivate=false

1 {
2   "arrayFilterEntry": [
3     {
4       "chart": [
5         {
6           "amount": 1,
7           "end": 1,
8           "start": 1
9         }
10       ],
11       "choiceOption": [
12         {
13           "label": "string",
14           "value": "string",
15           "scope": {
16             "max": 1,
17             "min": 1
18           }
19         }
20       ],
21       "controlType": "checkbox",
22       "filterKey": "string",
23       "label": "string",
24       "choiceOptionTotal": 1,
25       "choiceOptionTruncated": true,
26       "filterMeta": {
27         "ui": {
28           "headquartersOption": {
29             "country": [
30               {
31                 "country": "string",
32                 "state": [
33                   {
34                     "city": [
35                       "string"
36                     ],
37                     "state": "string"
38                   }
39                 ]
40               }
41             ]
42           }
43         }
44       },
45       "scope": {
46         "max": 1,
47         "min": 1
48       }
49     }
50   ],
51   "rangeFilterEntry": [
52     {
53       "chart": [
54         {
55           "amount": 1,
56           "end": 1,
57           "start": 1
58         }
59       ],
60       "choiceOption": [
61         {
62           "label": "string",
63           "value": "string",
64           "scope": {
65             "max": 1,
66             "min": 1
67           }
68         }
69       ],
70       "controlType": "checkbox",
71       "filterKey": "string",
72       "label": "string",
73       "choiceOptionTotal": 1,
74       "choiceOptionTruncated": true,
75       "filterMeta": {
76         "ui": {
77           "headquartersOption": {
78             "country": [
79               {
80                 "country": "string",
81                 "state": [
82                   {
83                     "city": [
84                       "string"
85                     ],
86                     "state": "string"
87                   }
88                 ]
89               }
90             ]
91           }
92         }
93       },
94       "scope": {
95         "max": 1,
96         "min": 1
97       }
98     }
99   ],
100   "filtersMeta": {
101     "defaultOptionLimit": 1,
102     "distributionKey": [
103       "string"
104     ],
105     "generatedAt": "2024-01-15T09:30:00Z",
106     "includeDistribution": true,
107     "includePrivate": true,
108     "includedTypeRecord": [
109       "string"
110     ],
111     "optionMode": "TOP_RESULTS",
112     "requestedTypeGroup": "string",
113     "defaultTypeGroup": "Organization",
114     "typeGroupMembership": [
115       {
116         "typeGroup": "Organization",
117         "typeRecord": [
118           "Company"
119         ]
120       }
121     ]
122   }
123 }

Get available filter options

Authentication

X-Client-Secretstring

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

Query parameters

typeGroupenumOptional

Type group for default filter scope. Ignored when typeRecord is provided.

Allowed values:

typeRecordstringOptional

Filter by entity type (Company, Investor, etc.)

includePrivatebooleanOptionalDefaults to false

Include governed expanded values

includeDistributionbooleanOptionalDefaults to false

Include range distribution charts

distributionKeylist of stringsOptional

Comma-separated or repeated filter keys for chart distribution (for example amountRaised,totalRaised)

Response

arrayFilterEntrylist of objects

Array filter entries

rangeFilterEntrylist of objects

Range filter entries

filtersMetaobject or nullOptional

Metadata for the generated filter option set

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error