API ReferenceProjectGA

Get Project Entities

Retrieve a list of entities in a project.

Path parameters

idstringRequired
The project identifier.

Headers

AuthorizationstringRequired
OAuth authentication of the form <token>.
AcceptenumRequired
The response format. Defaults to application/json.
Allowed values:

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)](/sayari-library/ontology/entities). 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).
combined_hs_codesstringOptional
Only return entities that have shipped or received 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 should begin with a '-' to indicate a descending sort, followed by a field name to sort on.
filtersobjectOptional
Filter for entities in a project. The format is `field=value`, where the equal sign is encoded as `%3D`. Supported fields are as follows
aggregationsstringOptional
Aggregations that should be returned for entities in the project.

Response

This endpoint returns an object.
aggregationsobject
Aggregation buckets for entities in a project.
datalist of objects
limitinteger
sizeobject
nextstringOptional
prevstringOptional

Errors