# Entities API

Use the Entities API to retrieve, create, update, and delete entities. An entity is a set of data that belongs together (such as for a product, campaign, project, story, recipe, or asset).

## Authentication

To use the Entities API, you need:

- The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.
- An access token and the client ID. Both are sent with every request. You can create a token through the [Content Hub interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) or by [requesting one using the API itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows)
   {% admonition type="info" name="Note" %}A [Copy method](https://doc.sitecore.com/ch/en/developers/cloud-dev/entity-1523348.html) is also available. {% /admonition %}


Version: v2.0
License: closed source

Metadata:
  - product: Content Hub

## Servers

```
https://{server}
```

Variables:
- `server`
  Default: "your-server"

## Security

### OAuth2

Type: oauth2
Authorization URL: /oauth/authorize
Token URL: /oauth/token
Scopes:

## Download OpenAPI description

 - [Entities API](https://api-docs.sitecore.com/_bundle/ch/entities-api/@v2.0/index.yaml)

## Entities

 - [GET /api/entities/{id}](https://api-docs.sitecore.com/ch/entities-api/entities/entitybyid.md): 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.
 - [PUT /api/entities/{id}](https://api-docs.sitecore.com/ch/entities-api/entities/updateentity.md): Updates an entity with the new details provided, including properties, relations, associated members and groups, and so on. Properties or relations not included in the request will be set to null.
 - [DELETE /api/entities/{id}](https://api-docs.sitecore.com/ch/entities-api/entities/deleteentity.md): Deletes an entity with the specified ID.
 - [GET /api/entities/identifier/{identifier}](https://api-docs.sitecore.com/ch/entities-api/entities/entitybyidentifier.md): Retrieves an entity with the specified identifier, including related data such as properties, member groups, renditions, permissions, and so on.
 - [PUT /api/entities/identifier/{identifier}](https://api-docs.sitecore.com/ch/entities-api/entities/updateentitybyidentifier.md): Updates an entity with the new details provided, including properties, relations, associated members and groups, and so on. Properties or relations not included in the request will be set to null.
 - [DELETE /api/entities/identifier/{identifier}](https://api-docs.sitecore.com/ch/entities-api/entities/deleteentitybyidentifier.md): Deletes an entity with the specified identifier.
 - [GET /api/entitydefinitions/{name}/entities](https://api-docs.sitecore.com/ch/entities-api/entities/entitiesbydefinition.md): Lists all entities for the specified entity definition.
 - [POST /api/entities](https://api-docs.sitecore.com/ch/entities-api/entities/addentity.md): Creates an entity with the specified details, including associated members and groups. The link to the associated `Entity Definition Resource` is required. The `self` property is ignored and can be om
 - [GET /api/entities/{entityId}/v2.0/renditions](https://api-docs.sitecore.com/ch/entities-api/entities/getrenditionsv2.md): Retrieves information about all renditions that exist for a specified entity, including their gateway links and delivery links.
 - [POST /api/entities/{entityId}/v2.0/renditions](https://api-docs.sitecore.com/ch/entities-api/entities/getfilteredrenditionsv2.md): Retrieves information about renditions that exist for a specified entity, including their gateway links and delivery links. Renditions can be filtered by `area of use` or by their `rendition link name
 - [GET /api/entities/{entityId}/v2.0/renditions/GetUserRenditionsCount](https://api-docs.sitecore.com/ch/entities-api/entities/getuserrenditioncountv2.md): Retrieves the count of user renditions for a specified entity.
## Lifecycle

 - [GET /api/entities/{id}/lifecycle](https://api-docs.sitecore.com/ch/entities-api/lifecycle/entitylifecycle.md): Retrieves the lifecycle actions that are available for the entity based on its permissions (independent of its current state). For example, if a user is allowed to submit an entity, the submit action
 - [POST /api/entities/{id}/lifecycle/submit](https://api-docs.sitecore.com/ch/entities-api/lifecycle/submitentity.md): Submits an entity in the created state for review allowing the user to approve or reject it. Requires the Submit permission.
 - [POST /api/entities/{id}/lifecycle/directpublish](https://api-docs.sitecore.com/ch/entities-api/lifecycle/directpublishentity.md): Publishes an entity with the created state directly, without going through the approval process. Requires the DirectPublish permission.
 - [POST /api/entities/{id}/lifecycle/approve](https://api-docs.sitecore.com/ch/entities-api/lifecycle/approveentity.md): Approves an entity in the review state. Requires the Approve permission.
 - [POST /api/entities/{id}/lifecycle/reject](https://api-docs.sitecore.com/ch/entities-api/lifecycle/rejectentity.md): Rejects an entity in the review state. A reason for the rejection must be provided. Requires the Reject permission.
 - [POST /api/entities/{id}/lifecycle/archive](https://api-docs.sitecore.com/ch/entities-api/lifecycle/archiveentity.md): Archives an approved entity. The entity can be restored if needed. Requires the Archive permission.
 - [POST /api/entities/{id}/lifecycle/restore](https://api-docs.sitecore.com/ch/entities-api/lifecycle/restoreentity.md): Restores an archived entity to the approved state. Requires the Archive permission.
 - [POST /api/entities/{id}/lifecycle/restorefromdelete](https://api-docs.sitecore.com/ch/entities-api/lifecycle/restorefromdelete.md): Restores an entity that has been soft deleted. Hard deleted entities cannot be restored. Requires the Delete permission.
 - [POST /api/entities/{id}/lifecycle/softdeleteentity](https://api-docs.sitecore.com/ch/entities-api/lifecycle/softdeleteentity.md): Deletes an entity, marking it as deleted but without permanently removing it from the system (soft deletion). This action can be reversed by restoring the entity later. Requires the Delete permission.