--- title: "Retrieve an entity using its identifier" method: GET path: "/api/entities/identifier/{identifier}" tags: ["Entities"] --- # Retrieve an entity using its identifier `GET /api/entities/identifier/{identifier}` ## Request - Base URL: `https://your-server` - URL: `https://your-server/api/entities/identifier/{identifier}` - Auth: OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves an entity with the specified identifier, including related data such as properties, member groups, renditions, permissions, and so on. ## Path parameters - `identifier` string, required ## Query parameters - `culture` string - `groups` string - `members` string - `renditions` string - `nestedRelations` string[] - `loadPermissions` boolean ## Response `200` Successful operation - EntityResource: Represents an entity resource with various properties, relations and metadata. - `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. ## Other responses - `301`: Redirected (Moved permanently). Applies only to light entities. - `400`: Request or Entity identifier not valid (for example, less than or equal to zero or does not exist). - `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)