Skip to content

Manage Entities

Once entities are resolved, you can list, retrieve, and optionally hard-delete them.

Get All Entities

GET/v1/core/entities

Returns a paginated list of all resolved entities in your tenant.

Parameters

NameTypeInDescription
limitintegerQueryMax results (default 50)
offsetintegerQueryPagination offset (default 0)
searchstringQuerySearch by display name or identifiers
entity_typestringQueryFilter by entity type

Get Entity Details

GET/v1/core/entities/{id}

Retrieves complete profile data for a specific entity, including its interaction history and merged identifiers.

Parameters

NameTypeInDescription
idstringPathThe Entity UUID

Response

json
{
  "id": "ent_550e8400...",
  "display_name": "Alice Smith",
  "entity_type": "customer",
  "behavioral_score": 0.85,
  "successful_interactions": 17,
  "total_interactions": 20,
  "identifiers": [
    {
      "id": "ident_123",
      "identifier_type": "email",
      "identifier_value": "alice@company.com"
    }
  ],
  "recent_interactions": [
    {
      "id": "int_3A21F...",
      "api": "sendgrid",
      "action_type": "send_email",
      "outcome": "success",
      "occurred_at": "2026-03-04T12:00:00Z"
    }
  ]
}

Delete Entity

DELETE/v1/core/entities/{id}

Hard deletes an entity and all of its associated interactions and identifiers from the database. This is irreversible.

Parameters

NameTypeInDescription
idstringPathThe Entity UUID

Released under the MIT License.