---
title: "List entities in an entity collection"
method: GET
path: "/entity-collections/{entity_collection_id}/entities"
tags: ["entityCollections > entities"]
---

# List entities in an entity collection

`GET /entity-collections/{entity_collection_id}/entities`

This method returns a list of the entities in the specified entity collection.

## Path parameters

- `entity_collection_id` string, required

## Query parameters

- `page` integer
- `page_limit` integer
- `name` string
- `status` 'processing' | 'ready'
- `sort_by` 'created_at' | 'updated_at' | 'name'
- `sort_option` string

## Headers

- `x-api-key` string, required

## Response `200`

The entities have been successfully retrieved.

- EntityCollectionsEntitiesListResponse200
  - `data` Entity[] — An array containing the entities.
    - `_id` string — The unique identifier of the entity.
    - `entity_collection_id` string — The unique identifier of the entity collection this entity belongs to.
    - `name` string — The name of the entity.
    - `description` string — A description of the entity.
    - `metadata` EntityMetadata — Custom metadata for the entity.
    - `asset_ids` string[] — An array of asset IDs associated with the entity.
    - `status` 'processing' | 'ready' — The current status of the entity creation process. **Values**: - `processing`: The entity is being processed and is not yet ready for use in searches. - `ready`: The entity is fully processed and can be used in search queries.
    - `created_at` string, date-time — The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was created.
    - `updated_at` string, date-time — The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was last updated.
  - `page_info` PageInfo — An object that provides information about pagination.
    - `limit_per_page` integer — The maximum number of items on each page.
    - `page` integer — The page you retrieved.
    - `total_page` integer — The total number of pages.
    - `total_results` integer — The total number of results.

## Other responses

- `400` — The request has failed.

---

[API](https://skmtc.net/twelvelabs/apis/twelvelabs-api.md) · [All operations](https://skmtc.net/twelvelabs/apis/twelvelabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twelvelabs/twelvelabs-api/revisions/fd9d80e384a8/schema)