SIsitecore
Entities

Retrieve an entity using its ID

Retrieves an entity using its ID and loads related data, including entity properties, member groups, renditions, permissions, and so on. You can also specify cultures for multi-language support.

get/api/entities/{id}

Request

Path parameters

idinteger required

The ID for the entity, for example, 39752.

Query parameters

culturestring

Culture of the entity you want to load, for example en-US . If no culture is provided, multi-language properties are not included. Use the cultures parameter to retrieve the entity in multiple cultures.

groupsstring

Member groups to include, for example, PreambleGroup,ChoiceGroup.

membersstring

Members to include, for example, PreambleThemeProperty,ChoiceThemeProperty.

renditionsstring

Renditions to include (comma-separated list), for example Thumbnail,Preview.

nestedRelationsstring[]

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

loadPermissionsboolean

Whether to include all permissions the user has on the entity, for example true or false.

culturesstring[]

Cultures in which to load the entity. The culture parameter can still specify a culture, even if this parameter is missing, for example true or false.

Response

Successful operation

idinteger

The ID for the entity, for example 39752.

identifierstring nullable

The identifier for the entity, for example, asset.VIPeventfruitbowl.

culturesstring[] nullable

The cultures associated with the entity, for example en-US.

propertiesobject nullable

The properties of the entity.

relationsobject nullable

The relations of the entity.

created_onstring date-time

The date and time when the entity was created.

modified_onstring date-time

The date and time when the entity was last modified.

locked_onstring date-time nullable

The date and time when the entity was locked.

requested_permissionsobject nullable

The requested permissions with identification if a certain user has the permissions.

is_root_taxonomy_itemboolean nullable

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean nullable

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger

The version of the entity.

modulesstring[] nullable

The modules associated with the entity.

Changes

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