Abstract Optional apiThe version of the API to use when fetching the Entities. Refer to the list of entities and their supported API versions.
Optional criteriaA list of criteria to be used to filter the results. Each entity exposes a specific list of criteria. Refer to the Entities SDK documentation in the Admin app for more information.
Optional customAdd custom parameters to the request URL.
Optional entityThe entity type to be fetched. e.g. 'item'
If reference is passed, the entity name of the reference will be used.
Optional federatedThe federated id of the entity to be fetched.
If id is passed, federatedId will be ignored.
Optional federatedA list of federated ids of the entities to be fetched.
If id or federatedId is passed, federatedIds will be ignored.
Optional idThe id of the entity to be fetched.
If referenceis passed, the id of the reference will be used.
Optional nextThe next page key received from the previous call. This is only used for pagination with entities that support V2 API.
Optional orderOptional referenceA reference to the entity to be fetched. e.g. item:123.
If reference is passed, it overrides entityName and id.
Optional relationuse suffix instead.
Optional relationsA list of relations to be fetched. e.g. ['type', 'typeProperties']. Each entity exposes a specific list of relations. Refer to the Entities SDK documentation in the Admin app for more information.
Optional skipA number of results to skip. This is only used for pagination with entities that support the Search API.
Optional skipUsed to skip hydrating relationships.
Optional suffixUsed to specify a suffix to the resource path.
Optional takeThe number of results to fetch. This is only used for pagination with entities that support the Search API.
Generated using TypeDoc
The contract used to specify the options for GET calls for Entities.