Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cometly.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the complete record for one contact: all emails, names, phones, location, custom profile fields, and optionally the full conversion + touchpoint journey or raw browsing session data.

​
When to use

  • “Show me Jane’s journey.”
  • “What pages did contact 12345 visit?”
  • “Tell me about jane@example.com.” (after using list_contacts to find the ID).

​
Parameters

ParameterTypeRequiredDescription
idintegerYesThe numeric ID of the contact.
include_comet_tokensbooleanNoAdds tracking tokens (last 5, including aliases from merged profiles).
include_eventsbooleanNoAdds the contact’s full event journey — all conversions and touchpoints sorted by most-recent first.
hide_direct_touchpointsbooleanNoWhen include_events is true, hides direct-traffic touchpoints from the events array. Defaults to true. Set to false if the user explicitly wants every touchpoint.
use_custom_field_labelsbooleanNoReplace raw profile_field_N keys with user-defined labels in the custom_fields object. Always set to true unless the user wants raw column names.
include_browsing_session_databooleanNoAdds up to the last 1000 raw page-view hits, most-recent first. Use only when the user asks about browsing or page-level behavior.

​
Custom fields

The tool’s use_custom_field_labels description lists every custom field configured on your Space (slug, label, type) so the model can reference them by their user-facing label in its response while still knowing the underlying slug. 
{
  "id": 41902,
  "emails": ["jane@example.com", "jane.doe+new@example.com"],
  "names": ["Jane Doe"],
  "phones": [],
  "location": "Austin, TX, US",
  "custom_fields": {
    "Customer Plan": "Premium",
    "Customer Age": 34,
    "Signup Date": "2025-09-12"
  }
}

​
Journey

When include_events: true, the response gains an events array sorted by most-recent first. Conversion events include event_name, amount, event_url, order_id, order_name, channel (browser/server), and integration. Touchpoint events include source, touchpoint_url, referrer_url, and the full ad hierarchy (ad_name, adset_name, campaign_name, account_name). hide_direct_touchpoints: true (default) drops source: direct touchpoints, which are usually noise. Pass false to include them.

​
Browsing session data

When include_browsing_session_data: true, the response gains a browsing_session_hits array with up to 1000 raw page views — each hit includes event_url, referrer_host, source, country, device_type, browser, os, event_name, and event_time_utc. This is heavy data. Only request it when the user explicitly asks about browsing or page-level behavior.

​
Caveats

  • Returns 404 ([not_found]) if no contact with that ID exists in the current Space.
  • All emails/names/phones are deduplicated across the contact and any merged profiles.
  • include_events and include_browsing_session_data are independent. Both can be set in the same request.