Skip to main content
POST
Entities

Authorizations

X-API-KEY
string
header
required

Path Parameters

entity_id
string<uuid>
required

Body

application/json

Optional query to specify which properties and relationships to return for the entity. If it is not provided, default properties will be returned.

properties
string[]

List of entity property names to query

Example:
relationships
EntityQueryRelationships · object

Relationship queries

numerical_observations
Numerical Observations · object

UUIDs of the numerical observations to query

Example:

Response

Successful Response

Response containing full entity profile

id
string<uuid>
required

The ID of the entity

name
string
required

The name of the entity

entity_type
enum<string>
required

The type of the entity

Available options:
Entity,
Animal,
Award,
Organization,
Company,
EducationalInstitution,
IntergovernmentalOrganization,
Person,
Event,
GPE,
Country,
CountrySubdivision,
DependentTerritory,
Municipality,
Continent,
Currency,
Industry,
FinancialMetric,
Group,
CorporateEvent,
PrivateCompanyFundingRound,
Facility,
Location,
Organism,
Plant,
Product,
Sanction,
WorkOfArt,
Law,
Language,
Exchange,
Future,
Commodity,
PositioningMetric,
MacroIndicatorPublication,
MacroIndicator,
ForeignExchangeRate,
CountryRegion
properties
Properties · object
required

List of property names available for this entity (e.g. id, name, currency).

Example:
relationships
EntityRelationships · object
required

Outgoing and incoming relationship types. This field is empty unless relationships.incoming and/or relationships.outgoing are provided in the request.

description
string | null

A short description of the entity

numerical_observations
any[]

Numerical observations keyed by observation type.

Example: