Entities

Retrieve a list of all entities for a specific entity definition

Lists all entities for the specified entity definition.

get/api/entitydefinitions/{name}/entities

Request

Base URL
https://your-server
Auth
OAuth 2
Authorization code/oauth/authorize
Token URL/oauth/token
TypeScript
https://skmtc.dev/sitecore/apis/entities-api/docs/api/entitydefinitions/:name/entities/get.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Entity definition name to use when filtering the entities, for example M.Asset.

skipinteger

Number of entities to skip before retrieving results, for example 1.

takeinteger

Number of entities to retrieve, for example 2.

culturestring

User culture in which to load the entities, for example en-US.

filterstring

Additional filters to apply when retrieving entities, for example status:active AND type:image.

groupsstring

Member groups to include in the retrieved entities, for example PreambleGroup,ChoiceGroup.

membersstring

Members to include in the retrieved entities, for example PreambleThemeProperty,ChoiceThemeProperty.

nestedRelationsstring[]

Nested relations to retrieve. Expected format: <name>|<role>[|<propertyName>].

Successful operation

last_hit_datastring[] nullable

The last returned hits, which are used to fetch the next page of results.

total_itemsinteger nullable

Gets or sets the total number of items.

returned_itemsinteger nullable

Gets or sets the number of returned items.

offsetinteger nullable

Gets or sets the offset of the items.

identifierstring nullable

Gets or sets the identifier of the resource.

No recorded changes to this operation across all 1 revision of this API.