---
title: "POST /workspaces/{workspaceId}/entities-list"
method: POST
path: "/workspaces/{workspaceId}/entities-list"
---

# POST /workspaces/{workspaceId}/entities-list

`POST /workspaces/{workspaceId}/entities-list`

Lists all entities in a workspace.

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `filters` ListEntitiesFilter[] — <p>A list of objects that filter the request.</p> <note> <p>Only one object is accepted as a valid input.</p> </note>
    - `parentEntityId` string — The parent of the entities in the list.
    - `componentTypeId` string — The ID of the component type in the entities in the list.
    - `externalId` string — The external-Id property of a component. The external-Id property is the primary key of an external storage system.
  - `maxResults` integer — <p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
  - `nextToken` string — The string that specifies the next page of results.

## Response `200`

Success

- ListEntitiesResponse
  - `entitySummaries` EntitySummary[] — A list of objects that contain information about the entities.
    - `entityId` string, required — The ID of the entity.
    - `entityName` string, required — The name of the entity.
    - `arn` string, required — The ARN of the entity.
    - `parentEntityId` string — The ID of the parent 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.
    - `description` string — The description of the entity.
    - `hasChildEntities` boolean — An <b>eventual</b> Boolean value that specifies whether the entity has child entities or not.
    - `creationDateTime` string, date-time, required — The date and time when the entity was created.
    - `updateDateTime` string, date-time, required — The last date and time when the entity was updated.
  - `nextToken` string — The string that specifies the next page of results.

## Other responses

- `480` — InternalServerException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — 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)