Relations

Read live relations and history

GET/relations

Scopegraph:readRoleCurrent memberBilling1 credit per call

Returns the live edges for one entity and relation type, plus the full version history across them. Nothing is deleted: a retired edge stays in history with superseded_at set.

Query parameters

fromKindenumrequired

customer · account_person

fromIduuidrequired

relationTypeenumrequired

matches_icp · matches_persona · interested_in_use_case · uses_product · discussed_competitor

Response

200 · application/json

liveRelation[]

historyRelationVersion[]

curl --fail-with-body "https://app.ghostgtm.ai/api/v1/relations?fromKind=customer&fromId=6b1e9a44-2c7d-4f0a-9e3b-1d5c8a7f2e90&relationType=matches_icp" \
  -H "Authorization: Bearer $GHOST_API_KEY"

Response200

{
  "live": [
    {
      "id": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
      "from_entity_id": "6b1e9a44-2c7d-4f0a-9e3b-1d5c8a7f2e90",
      "from_entity_kind": "customer",
      "to_entity_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
      "to_entity_kind": "icp",
      "relation_type": "matches_icp",
      "source": "human:usr_91c0…",
      "confidence": 1,
      "evidence": null,
      "superseded_by": null,
      "superseded_at": null,
      "created_at": "2026-08-14T12:00:00.000Z"
    }
  ],
  "history": [
    {
      "id": "v1",
      "relation_id": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
      "version_no": 1,
      "action": "confirm",
      "actor_kind": "human",
      "actor_id": "usr_91c0…",
      "reason": "Confirmed on review",
      "created_at": "2026-08-14T12:00:00.000Z"
    }
  ]
}

Try itGET /relations

API keyfromKindqueryfromIdqueryrelationTypequery

Sends to app.ghostgtm.ai/api/v1 · 1 credit per call