List entities in an entity collection

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

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Key page.

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path Parameters

entity_collection_idstringRequired

The unique identifier of the entity collection for which the platform will retrieve the entities.

Query Parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

namestringOptional

Filter entities by name.

statusenumOptional

Filter entities by status.

Allowed values:

sort_byenumOptionalDefaults to created_at

The field to sort on. The following options are available:

created_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was created.
updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was updated.
name: Sorts by the name.

The field to sort on. The following options are available: - `created_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the entity was created. - `updated_at:` Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the entity collection was updated. - `name`: Sorts by the name.

Allowed values:

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

The sorting direction. The following options are available: - `asc` - `desc` **Default**: `desc`.

Response

The entities have been successfully retrieved.

datalist of objects or null

An array containing the entities.

page_infoobject or null

An object that provides information about pagination.

1	curl -G https://api.twelvelabs.io/v1.3/entity-collections/6298d673f1090f1100476d4c/entities \
2	-H "x-api-key: <apiKey>" \
3	--data-urlencode "name=My entity" \
4	-d status=ready \
5	-d sort_by=created_at

1	{
2	"data": [
3	{
4	"_id": "6298d673f1090f1100476d4c",
5	"name": "John Doe",
6	"description": "Famous soccer player",
7	"metadata": {},
8	"asset_ids": [
9	"6298d673f1090f1100476d4c",
10	"6298d673f1090f1100476d4d"
11	],
12	"status": "processing",
13	"created_at": "2022-06-02T10:30:00Z",
14	"updated_at": "2022-06-02T10:30:00Z"
15	}
16	],
17	"page_info": {
18	"limit_per_page": 10,
19	"page": 1,
20	"total_page": 10,
21	"total_results": 10
22	}
23	}

Authentication

Note

Path Parameters

Query Parameters

Response

Errors

Note