Skip to navigation

Retrieve an entity collection

This method retrieves details about the specified entity collection.

Authentication

x-api-keystring

Your API key.

Note

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

Path parameters

entity_collection_idstringRequired
The unique identifier of the entity collection to retrieve.

Response

The entity collection has been successfully retrieved.
_idstringOptional
The unique identifier of the entity collection.
namestringOptional
The name of the entity collection.
descriptionstringOptional
The description of the entity collection.
created_atstringOptionalformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was created.

updated_atstringOptionalformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was last updated.

Errors

400
Bad Request Error