--- title: "Retrieve a list of all entities for a specific entity definition" method: GET path: "/api/entitydefinitions/{name}/entities" tags: ["Entities"] --- # Retrieve a list of all entities for a specific entity definition `GET /api/entitydefinitions/{name}/entities` ## Request - Base URL: `https://your-server` - URL: `https://your-server/api/entitydefinitions/{name}/entities` - Auth: OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all entities for the specified entity definition. ## Path parameters - `name` string, required ## Query parameters - `skip` integer - `take` integer - `culture` string - `filter` string - `groups` string - `members` string - `nestedRelations` string[] ## Response `200` Successful operation - EntityCollectionResource: Collection of entities resulted of a query - `last_hit_data` string[], nullable: The last returned hits, which are used to fetch the next page of results. - `items` EntityResource[], nullable: Gets or sets the list of items. - `id` integer: The ID for the entity, for example `39752`. - `identifier` string, nullable: The identifier for the entity, for example, `asset.VIPeventfruitbowl`. - `cultures` string[], nullable: The cultures associated with the entity, for example `en-US`. - `properties` object, nullable: The properties of the entity. - `relations` object, nullable: The relations of the entity. - `created_by` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `created_on` string, date-time: The date and time when the entity was created. - `modified_by` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `modified_on` string, date-time: The date and time when the entity was last modified. - `locked_by` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `locked_on` string, date-time, nullable: The date and time when the entity was locked. - `entitydefinition` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `copy` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `copyasync` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `permissions` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `requested_permissions` object, nullable: The requested permissions with identification if a certain user has the permissions. - `lifecycle` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `saved_selections` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `roles` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `annotations` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `is_root_taxonomy_item` boolean, nullable: Gets or sets a value indicating whether the entity is a root taxonomy item. - `is_path_root` boolean, nullable: Gets or sets a value indicating whether the entity is a path root. - `inherits_security` boolean: Gets or sets a value indicating whether the entity inherits security. - `is_system_owned` boolean: Gets or sets a value indicating whether the entity is system owned. - `version` integer: The version of the entity. - `full` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `modules` string[], nullable: The modules associated with the entity. - `self` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `total_items` integer, nullable: Gets or sets the total number of items. - `returned_items` integer, nullable: Gets or sets the number of returned items. - `offset` integer, nullable: Gets or sets the offset of the items. - `next` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `previous` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. - `identifier` string, nullable: Gets or sets the identifier of the resource. - `self` Link: Represents a link to a resource. - `href` string, nullable: Gets or sets the URI that points to the resource this link refers to. - `filename_properties` string[], nullable: Gets or sets the URI that points to the resource this link refers to. - `title` string, nullable: Gets or sets the title that describes this link. - `templated` boolean: Gets or sets a value indicating whether the contained URI is a template. ## Other responses - `400`: Request or Entity definition is not valid (for example, less than or equal to zero or does not exist), or at least one culture is null. - `401`: Unauthorized request - `404`: Entity not found or user not authorized --- [API](https://skmtc.dev/sitecore/apis/entities-api.md) - [All operations](https://skmtc.dev/sitecore/apis/entities-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sitecore/apis/entities-api/revisions/328bbdd51028?raw)