v1

latestOpenAPI 3.1.02026-08-0484962.5 KB
Entity API

Get entities

get/api/v2/public/entities/

Query parameters

cursorstring

The pagination cursor value.

entityTypeIdsstring

Comma separated Entity type ID(s) to restrict to (use schema API above to retrieve all available entity types).

filterPredicateIdstring

Set a predicate filter by using filterPredicateId and filterValue query params. filterPredicateId is the ID of the predicate to be used. See predicate schema isFilterable field for supported predicate IDs.

filterValuestring

Set a predicate filter by using filterPredicateId and filterValue query params. filterValue is the value to be used for the filter.

idsstring

Comma separated entity IDs to restrict returned entities.

pageSizeinteger

Number of results to return per page. The default value is 2 for Free Plan and 10 for Any Paid Plan. The maximum value is 100.

predicateIdsstring

Comma separated Predicate ID(s) to restrict returned properties. Returns just the name property if not set.

Response

nextstring uri nullable

URL of next page

previousstring uri nullable

URL of previous page