Get Generic Entity by ID

Get Generic Entity by ID

The V1 Generic Entity API is fully supported and recommended for all environments below version 2.3.40. If your environment is on version 2.3.40 or later, you can optionally migrate to V3. Contact Customer Success to enable V3 for your account.

Path Parameters:

ParameterTypeMandatoryDescriptionExample
idstringtrueGeneric Entity ID that needs to be fetched3fa85f64-5717-4562-b3fc-2c963f66afa6
Query Parameters:
ParameterTypeMandatoryDescriptionExample
includeReferencersbooleanfalseOptional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

This API requires PROTECTED_API permission(s).

Path Params
uuid
required

Generic Entity ID that needs to be fetched

Query Params
boolean

Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json