Definitions

List definitions

GET/definitions

Scopegraph:readRoleCurrent member; module visibility appliesBilling1 credit per call

Lists the workspace's definitions. Non-admins see only definitions in enabled modules whose visibility includes their role.

Query parameters

includeArchivedbooleanoptional

Include archived definitions. Default false.

moduleKeysenum[]optional

Filter by module: customers · partners · investors · recruiting · advisors · vendors.

limitintegeroptional

Page size. Default 50, maximum 200.

cursoruuidoptional

The nextCursor from the previous page. Omit for the first page.

Response

200 · application/json

itemsDefinition[]

nextCursoruuid | null

curl --fail-with-body "https://app.ghostgtm.ai/api/v1/definitions?limit=50" \
  -H "Authorization: Bearer $GHOST_API_KEY"

Response200

{
  "items": [
    {
      "id": "d2c4e6a8-1b3d-4f5e-9a7c-8b0d1e2f3a41",
      "workspace_id": "ws_7f3a…",
      "name": "Integration stage",
      "slug": "integration_stage",
      "description": null,
      "module_key": "customers",
      "entity_kinds": [
        "account"
      ],
      "value_type": "enum",
      "cardinality": "exclusive",
      "enum_values": [
        {
          "label": "New",
          "slug": "new",
          "archived": false
        },
        {
          "label": "Qualified",
          "slug": "qualified",
          "archived": false
        }
      ],
      "instruction": null,
      "refresh_policy": "on_ingest",
      "capture_enabled": false,
      "auto_apply_threshold": 0.85,
      "review_threshold": 0.6,
      "chat_visible": true,
      "state": "live",
      "est_credits_low": null,
      "est_credits_high": null,
      "last_run_credits": null,
      "created_by": "api_key:key_3e…",
      "reason": "Track qualification from our integration",
      "created_at": "2026-09-02T10:11:12.000Z",
      "updated_at": "2026-09-02T10:11:12.000Z",
      "archived_at": null
    }
  ],
  "nextCursor": null
}

Try itGET /definitions

API keyincludeArchivedquerymoduleKeysquerylimitquerycursorquery

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