Skip to navigation
EntitiesManage entities

Retrieve an entity

This method retrieves details about the specified entity.

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.
entity_idstringRequired
The unique identifier of the entity to retrieve.

Response

The entity has been successfully retrieved.
_idstringOptional
The unique identifier of the entity.
entity_collection_idstringOptional
The unique identifier of the entity collection this entity belongs to.
namestringOptional
The name of the entity.
descriptionstringOptional
A description of the entity.
metadataobjectOptional
Custom metadata for the entity.
asset_idslist of stringsOptional
An array of asset IDs associated with the entity.
statusenumOptional

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.
Allowed values:
created_atstringOptionalformat: "date-time"

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

updated_atstringOptionalformat: "date-time"

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

Errors

400
Bad Request Error