Project

Get Project Entities

Beta
GET

This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.
Retrieve a list of entities in a project.

Path parameters

idstringRequired
The project identifier.

Headers

AcceptenumRequired
The response format. Defaults to application/json.
Allowed values: application/jsontext/csvapplication/vnd.ms-excel

Query parameters

nextstringOptional
The pagination token for the next page of entities.
prevstringOptional
The pagination token for the previous page of entities.
limitintegerOptional
Limit total entities returned. Defaults to 1,000. Max 10,000.
entity_typesenumOptional

Only return entities of the specified entity type(s). Defaults to all types.

geo_facetsbooleanOptional
Whether to include geo facets in the response. Defaults to false.
hs_codesstringOptional
Only return entities with the specified HS code(s).
received_hs_codesstringOptional
Only return entities that received the specified HS code(s).
shipped_hs_codesstringOptional
Only return entities that shipped the specified HS code(s).
translationstringOptional
The language code to translate the entity labels to. Defaults to the user's preferred language.
sortenumOptional
Defines a sort order on a field, either ascending or descending. The value must begin with either a '+' or a '-' to indicate an ascending or descending sort, respectively, followed by a field name to sort on.
filtersstringOptional
Only return entities that match the specified filters.
aggregationsstringOptional
Aggregations for entities in a project.

Response

This endpoint returns an object
aggregations
object
Aggregation buckets for entities in a project.
data
list of objects
limit
integer
size
object
next
stringOptional
prev
stringOptional
GET
1curl https://api.sayari.com/v1/projects/gPq6EY/contents/entity \
2 -H "Accept: application/json" \
3 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "aggregations": {
3 "hit_count": [
4 {
5 "key": "hit_count",
6 "doc_count": 1
7 }
8 ],
9 "country": [
10 {
11 "key": "IND",
12 "doc_count": 1,
13 "label": "India"
14 }
15 ],
16 "upstream_country": [],
17 "risk": [
18 {
19 "key": "basel_aml",
20 "doc_count": 1
21 },
22 {
23 "key": "cpi_score",
24 "doc_count": 1
25 },
26 {
27 "key": "forced_labor_xinjiang_origin_subtier",
28 "doc_count": 1
29 },
30 {
31 "key": "forced_labor_uflpa_origin_subtier",
32 "doc_count": 1
33 },
34 {
35 "key": "forced_labor_sheffield_hallam_university_reports_origin_subtier",
36 "doc_count": 1
37 }
38 ],
39 "upstream_risk": [],
40 "source": [
41 {
42 "key": "faa9caafcfabcee04ef2f0b21dd9197a",
43 "doc_count": 1,
44 "label": "South Korea Imports & Exports (2021 - Present)"
45 }
46 ],
47 "business_purpose": [],
48 "tag_ids": [],
49 "case_statuses": [
50 {
51 "key": "not_assigned",
52 "doc_count": 1
53 }
54 ],
55 "shipment_counts": [
56 {
57 "key": "receiver_of",
58 "doc_count": 5,
59 "comment": "Sum of all shipments of this type across matching documents"
60 },
61 {
62 "key": "shipper_of",
63 "doc_count": 0,
64 "comment": "Sum of all shipments of this type across matching documents"
65 }
66 ],
67 "shipped_hs_codes": {
68 "doc_count": 0,
69 "hs_code_terms": {
70 "doc_count_error_upper_bound": 0,
71 "sum_other_doc_count": 0,
72 "buckets": []
73 }
74 },
75 "received_hs_codes": {
76 "doc_count": 2,
77 "hs_code_terms": {
78 "doc_count_error_upper_bound": 0,
79 "sum_other_doc_count": 0,
80 "buckets": [
81 {
82 "key": "271290",
83 "doc_count": 1,
84 "hs_code_sums": {
85 "value": 4
86 }
87 },
88 {
89 "key": "271220",
90 "doc_count": 1,
91 "hs_code_sums": {
92 "value": 1
93 }
94 }
95 ]
96 }
97 },
98 "match_results": [
99 {
100 "key": "sayari",
101 "doc_count": 1
102 }
103 ],
104 "source_type": [
105 {
106 "key": "trade_data",
107 "doc_count": 1
108 }
109 ],
110 "region": [
111 {
112 "key": "asia_pacific",
113 "doc_count": 1
114 }
115 ]
116 },
117 "data": [
118 {
119 "id": "GOeOE8",
120 "project": "gPq6EY",
121 "label": "RAMESH FLOWERS PRIVATE LIMITED",
122 "created": "2024-03-08 18:52:59.41176+00",
123 "updated": "2024-03-08 18:52:59.41176+00",
124 "updated_by": "auth0|5e45bd8caccd890e68147513",
125 "version": 0,
126 "type": "entity",
127 "entity_id": "FyI9lrlmA-7z_3enlTOhlw",
128 "tag_ids": [],
129 "case_status": "not_assigned",
130 "match_strength": {
131 "rules": {
132 "is_strong_v1": false,
133 "any_v1": "",
134 "is_any_v1": false,
135 "strong_v1": "",
136 "is_weak_v1": false,
137 "weak_v1": "",
138 "strength_v1": "none"
139 }
140 },
141 "shipped_hs_codes": [],
142 "received_hs_codes": [
143 "271290",
144 "271220"
145 ],
146 "trade_count_incl_mg": {
147 "receiver_of": 5,
148 "shipper_of": 0
149 },
150 "upstream": {
151 "risk": [],
152 "countries": []
153 },
154 "summary": {
155 "attribute_counts": {
156 "name": 1,
157 "country": 1,
158 "address": 2
159 },
160 "attributes": {
161 "address": [
162 {
163 "value": {
164 "value": "A62(A) SIPCOT INDUSTRIAL COMPLEX THERKU VEERAPANDIAPURAM P.O. TUTICORIN628002 TAMIL NADU INDIA GSTIN 33AAACR9251P1ZY IEC 3595005775 PANNO AAACR92",
165 "house": "Gstin 33aaacr9251p1zy",
166 "house_number": "3595005775",
167 "road": "Panno",
168 "city": "NADU",
169 "state": "Tamil Nadu",
170 "postcode": "Aaacr92",
171 "country": "India",
172 "x": 74.99698,
173 "y": 12.85316,
174 "precision_code": "G3",
175 "normalized": "33AAACR9251P1ZY 3595005775 A62A AAACR92 COMPLEX GSTIN IEC INDIA INDUSTRIAL NADU O P PANNO SIPCOT TAMIL THERKU TUTICORIN628002 VEERAPANDIAPURAM"
176 },
177 "properties": [
178 {
179 "record": "faa9caafcfabcee04ef2f0b21dd9197a/MAEU226738031/1693109172077",
180 "record_count": 4,
181 "editable": false
182 }
183 ]
184 },
185 {
186 "value": {
187 "value": "A62(A) SIPCOT INDUSTRIAL COMPLEX TUTICORIN628002 TAMIL NADU INDIA GSTIN 33AAACR9251P1ZY IEC 3595005775 PH914612340505 TO 2340509",
188 "house": "Gstin 33aaacr9251p1zy",
189 "house_number": "3595005775",
190 "road": "Ph914612340505 To 2340509",
191 "city": "TO",
192 "state": "Tamil Nadu",
193 "postcode": "Tuticorin628002",
194 "country": "India",
195 "x": 77.06,
196 "y": 20.00896,
197 "precision_code": "G3",
198 "normalized": "2340509 33AAACR9251P1ZY 3595005775 A62A COMPLEX GSTIN IEC INDIA INDUSTRIAL NADU PH914612340505 SIPCOT TAMIL TO TUTICORIN628002"
199 },
200 "properties": [
201 {
202 "record": "faa9caafcfabcee04ef2f0b21dd9197a/MAEU1KT860018/1693109343516",
203 "record_count": 2,
204 "editable": false
205 }
206 ]
207 }
208 ],
209 "country": [
210 {
211 "value": {
212 "value": "IND",
213 "context": "address",
214 "Original Text": "India"
215 },
216 "properties": [
217 {
218 "record": "faa9caafcfabcee04ef2f0b21dd9197a/MAEU226738031/1693109172077",
219 "record_count": 6,
220 "editable": false
221 }
222 ]
223 }
224 ],
225 "name": [
226 {
227 "value": {
228 "value": "RAMESH FLOWERS PRIVATE LIMITED",
229 "context": "primary"
230 },
231 "properties": [
232 {
233 "record": "faa9caafcfabcee04ef2f0b21dd9197a/MAEU226738031/1693109172077",
234 "record_count": 10,
235 "editable": false
236 }
237 ]
238 }
239 ]
240 },
241 "countries": [
242 "IND"
243 ],
244 "id": "FyI9lrlmA-7z_3enlTOhlw",
245 "identifiers": [],
246 "label": "RAMESH FLOWERS PRIVATE LIMITED",
247 "record_count": 5,
248 "related_entities_count": 8,
249 "relationship_counts": {
250 "notify_party_of": 5,
251 "receives_from": 3,
252 "receiver_of": 5
253 },
254 "risk": {
255 "forced_labor_xinjiang_origin_subtier": {
256 "value": 3,
257 "metadata": {},
258 "level": "high"
259 },
260 "basel_aml": {
261 "value": 4.95,
262 "metadata": {
263 "country": [
264 "IND"
265 ]
266 },
267 "level": "relevant"
268 },
269 "forced_labor_sheffield_hallam_university_reports_origin_subtier": {
270 "value": 3,
271 "metadata": {},
272 "level": "high"
273 },
274 "cpi_score": {
275 "value": 40,
276 "metadata": {
277 "country": [
278 "IND"
279 ]
280 },
281 "level": "relevant"
282 },
283 "forced_labor_uflpa_origin_subtier": {
284 "value": 3,
285 "metadata": {},
286 "level": "high"
287 }
288 },
289 "source_counts": {
290 "faa9caafcfabcee04ef2f0b21dd9197a": {
291 "count": 10,
292 "label": "South Korea Imports & Exports (2021 - Present)"
293 }
294 },
295 "trade_count": {
296 "sent": 0,
297 "received": 5
298 },
299 "type": "company",
300 "user_attribute_counts": {},
301 "user_record_count": 0,
302 "user_related_entities_count": 0,
303 "user_relationship_counts": {},
304 "addresses": [
305 "A62(A) SIPCOT INDUSTRIAL COMPLEX THERKU VEERAPANDIAPURAM P.O. TUTICORIN628002 TAMIL NADU INDIA GSTIN 33AAACR9251P1ZY IEC 3595005775 PANNO AAACR92",
306 "A62(A) SIPCOT INDUSTRIAL COMPLEX TUTICORIN628002 TAMIL NADU INDIA GSTIN 33AAACR9251P1ZY IEC 3595005775 PH914612340505 TO 2340509"
307 ],
308 "names": [
309 "RAMESH FLOWERS PRIVATE LIMITED"
310 ]
311 },
312 "psa": {
313 "risk": [
314 "eu_high_risk_third",
315 "basel_aml",
316 "cpi_score",
317 "owner_of_regulatory_action_entity"
318 ],
319 "countries": [
320 "USA",
321 "CAN",
322 "MAR",
323 "BEL",
324 "GEO"
325 ],
326 "count": 2
327 }
328 }
329 ],
330 "limit": 10000,
331 "size": {
332 "count": 1,
333 "qualifier": "eq"
334 }
335}