Sitecore API catalog/Entity definitions API/Entities

Entities

Use this endpoint to retrieve all entities that match a specific entity definition.

Operations

Retrieve all entities for a specific entity definition

Request

Lists all entities that match a specific entity definition, with support for filtering, pagination, and localization.

Security
OAuth2.0
Path
namestringrequired

Entity definition name to filter the entities, for example, abc.

Query
skipinteger, (int32)

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

takeinteger, (int32)

Number of entities to retrieve, for example, 1.

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, DefaultGroup,SystemGroup.

membersstring

Members to include in the retrieved entities, for example, TestStringProperty,SystemOwnedStringProperty.

nestedRelationsArray of strings

Related entities to include fully loaded in the result, for example, ParentRelation,ChildRelation.

curl -i -X GET \
  'https://your-server/api/entitydefinitions/{name}/entities?skip=0&take=0&culture=string&filter=string&groups=string&members=string&nestedRelations=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation.

Bodyapplication/json
itemsArray of objects(EntityResource)
totalinteger, (int32)
selfobject(Link)

Represents a link to a resource.

Response
{
  "items": [
    { … }
  ],
  "total": 0,
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}