---
title: "GET /workspaces/{workspaceId}/entities/{entityId}"
method: GET
path: "/workspaces/{workspaceId}/entities/{entityId}"
---

# GET /workspaces/{workspaceId}/entities/{entityId}

`GET /workspaces/{workspaceId}/entities/{entityId}`

Retrieves information about an entity.

## Path parameters

- `workspaceId` string, required
- `entityId` string, required

## Response `200`

Success

- GetEntityResponse
  - `entityId` string, required — The ID of the entity.
  - `entityName` string, required — The name of the entity.
  - `arn` string, required — The ARN of the entity.
  - `status` object, required — The current status of the entity.
    - `state` 'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'ERROR' — The current state of the entity, component, component type, or workspace.
    - `error` object — The error message.
      - `code` 'VALIDATION_ERROR' | 'INTERNAL_FAILURE' | 'SYNC_INITIALIZING_ERROR' | 'SYNC_CREATING_ERROR' | 'SYNC_PROCESSING_ERROR' | 'SYNC_DELETING_ERROR' | 'PROCESSING_ERROR' | 'COMPOSITE_COMPONENT_FAILURE' — The error code.
      - `message` string — The error message.
  - `workspaceId` string, required — The ID of the workspace.
  - `description` string — The description of the entity.
  - `components` object — An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
  - `parentEntityId` string, required — The ID of the parent entity for this entity.
  - `hasChildEntities` boolean, required — A Boolean value that specifies whether the entity has associated child entities.
  - `creationDateTime` string, date-time, required — The date and time when the entity was created.
  - `updateDateTime` string, date-time, required — The date and time when the entity was last updated.
  - `syncSource` string — The syncSource of the sync job, if this entity was created by a sync job.
  - `areAllComponentsReturned` boolean — This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — ServiceQuotaExceededException

---

[API](https://skmtc.net/aws/apis/iottwinmaker.md) · [All operations](https://skmtc.net/aws/apis/iottwinmaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iottwinmaker/versions/a66a26fd65ea/schema)