Get Project Entities
GAThis endpoint is deprecated.
Path parameters
id
The project identifier.
Headers
Authorization
OAuth authentication of the form <token>.
Accept
The response format. Defaults to application/json.
Allowed values:
Query parameters
next
The pagination token for the next page of entities.
prev
The pagination token for the previous page of entities.
limit
Limit total entities returned. Defaults to 1,000. Max 10,000.
geo_facets
Whether to include geo facets in the response. Defaults to false.
hs_codes
Only return entities with the specified HS code(s) in their supply chain.
received_hs_codes
Only return entities that received the specified HS code(s).
shipped_hs_codes
Only return entities that shipped the specified HS code(s).
combined_hs_codes
Only return entities that have shipped or received the specified HS code(s).
translation
The language code to translate the entity labels to. Defaults to the user's preferred language.
sort
Defines a sort order on a field, either ascending or descending. The value should begin with a ’-’ to indicate a descending sort, followed by a field name to sort on.
filters
Filter for entities in a project. The format is field=value
, where the equal sign is encoded as %3D
. Supported fields are as follows
aggregations
Aggregations that should be returned for entities in the project.
Response
This endpoint returns an object.
aggregations
Aggregation buckets for entities in a project.
data
limit
size
next
prev