API ReferenceManage entities

List entities in an entity collection

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

Path parameters

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

Headers

x-api-keystringRequired

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.
Allowed values:
sort_optionstringOptionalDefaults to 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.

Errors