List entity collections

This method returns a list of the entity collections in your account.

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>

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 entity collections by name.

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 collection was updated.
updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was created.
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 collection was updated. - `updated_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the entity collection was created. - `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 entity collections have been successfully retrieved.

datalist of objects or null

An array containing the entity collections.

page_infoobject or null

An object that provides information about pagination.

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

1	{
2	"data": [
3	{
4	"_id": "6298d673f1090f1100476d4c",
5	"name": "My Collection",
6	"description": "My first collection",
7	"created_at": "2022-06-02T10:30:00Z",
8	"updated_at": "2022-06-02T10:30:00Z"
9	}
10	],
11	"page_info": {
12	"limit_per_page": 10,
13	"page": 1,
14	"total_page": 10,
15	"total_results": 10
16	}
17	}

Authentication

Note

Query Parameters

Response

Errors

Note