v2.0
OAS 3.1.0
Golden API v2
Client Libraries
Entity API
Entity API Operations
Get entities
Query Parameters
- cursorType:string
The pagination cursor value.
- entityTypeIdsType:string
Comma separated Entity type ID(s) to restrict to (use schema API above to retrieve all available entity types).
- filterPredicateIdType:string
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.
- filterValueType:string
Set a predicate filter by using filterPredicateId and filterValue query params. filterValue is the value to be used for the filter.
- idsType:string
Comma separated entity IDs to restrict returned entities.
- pageSizeType:integer
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.
- predicateIdsType:string
Comma separated Predicate ID(s) to restrict returned properties. Returns just the name property if not set.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example forGET/api/v2/public/entities/
curl https://golden.com/api/v2/public/entities/
{
"next": "https://example.com",
"previous": "https://example.com",
"results": [
{
"id": 1,
"latestVersionId": 1,
"properties": [
{
"predicateId": "…",
"instances": [
{
"value": 1,
"citations": [
{
"title": "…",
"url": "…"
}
]
}
]
}
]
}
]
}