Get Project Entities

Beta
Retrieves a list of entities for a specific project with pagination support.

Path parameters

project_idstringRequired

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

entity_idlist of stringsOptional
Filter by entity IDs
uploadslist of stringsOptional
Filter by upload IDs
case_statuslist of enumsOptional
Filter by case status
Allowed values:
tagslist of stringsOptional
Filter by tag IDs
match_resultlist of enumsOptional
Filter by match result
Allowed values:
match_strength_v1list of enumsOptional
Filter by match strength
Allowed values:
entity_typeslist of stringsOptional
Filter by entity types
geo_facetsbooleanOptionalDefaults to false
Include geo facets
exact_matchbooleanOptional
Use exact matching
hs_codeslist of stringsOptional
Filter by HS codes
received_hs_codeslist of stringsOptional
Filter by received HS codes
shipped_hs_codeslist of stringsOptional
Filter by shipped HS codes
upstream_productlist of stringsOptional
Filter by upstream product
limitintegerOptional
Maximum number of results to return
tokenstringOptional
Pagination token
sortlist of stringsOptional
Sort fields
aggregationslist of stringsOptional
Fields to aggregate
num_aggregation_bucketsintegerOptional
Number of aggregation buckets
risklist of enumsOptional
List of risk factors to filter by
risk_categorylist of enumsOptional
List of risk categories to filter by. An entity matches if it has any risk factor belonging to one of the specified categories

Response

This endpoint returns an object.
limitinteger
datalist of objects
sizeobject
next_tokenstringOptional
prev_tokenstringOptional

Errors