Get a Close lead journey

Return the Sapt web journey for one native Close lead without importing it into Sapt CRM. Sapt reads the lead from the project Close connection, then resolves every tracked browser by exact Close id, normalized email/phone, or a single-candidate fbclid. A valid lead with no tracked visit returns matched: false and an empty journey. Authenticate with Authorization: ApiKey <key> using a project service-account key scoped to crm_objects:read.

GET /projects/{projectId}/integrations/close/journey

Get a Close lead journey

cURL

curl --request GET \
  --url https://api.sapt.ai/projects/{projectId}/integrations/close/journey \
  --header 'Authorization: Bearer <token>'

200

{
  "close_lead_id": "<string>",
  "matched": true,
  "match_method": "close_lead_id",
  "visitor_ids": [
    "<string>"
  ],
  "journey": {
    "items": [
      {
        "id": "<string>",
        "source": "ledger",
        "kind": "web",
        "type": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "detail": {},
        "scheduledFor": "2023-11-07T05:31:56Z",
        "status": "sent",
        "channel": "<string>",
        "direction": "inbound",
        "recordId": "<string>",
        "workflowId": "<string>",
        "provenance": {
          "workflowId": "<string>",
          "runId": "<string>",
          "stepIndex": 123,
          "totalSteps": 123,
          "campaignId": "<string>"
        },
        "cancel": {
          "kind": "workflow_run_v2",
          "id": "<string>"
        }
      }
    ],
    "nextCursor": "<string>",
    "header": {
      "firstTouch": {
        "utm_source": "<string>",
        "utm_medium": "<string>",
        "utm_campaign": "<string>",
        "utm_term": "<string>",
        "utm_content": "<string>",
        "gclid": "<string>",
        "fbclid": "<string>",
        "msclkid": "<string>",
        "ttclid": "<string>",
        "wbraid": "<string>",
        "gbraid": "<string>",
        "li_fat_id": "<string>",
        "twclid": "<string>",
        "epik": "<string>",
        "dclid": "<string>",
        "sapt_cid": "<string>",
        "referrer": "<string>",
        "landingPath": "<string>",
        "userAgent": "<string>",
        "ip": "<string>",
        "fbc": "<string>",
        "fbp": "<string>"
      },
      "lastTouch": {
        "utm_source": "<string>",
        "utm_medium": "<string>",
        "utm_campaign": "<string>",
        "utm_term": "<string>",
        "utm_content": "<string>",
        "gclid": "<string>",
        "fbclid": "<string>",
        "msclkid": "<string>",
        "ttclid": "<string>",
        "wbraid": "<string>",
        "gbraid": "<string>",
        "li_fat_id": "<string>",
        "twclid": "<string>",
        "epik": "<string>",
        "dclid": "<string>",
        "sapt_cid": "<string>",
        "referrer": "<string>",
        "landingPath": "<string>",
        "userAgent": "<string>",
        "ip": "<string>",
        "fbc": "<string>",
        "fbp": "<string>"
      },
      "firstSeenAt": "2023-11-07T05:31:56Z",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "webSessions": 123,
      "pageviews": 123,
      "revenueCents": 123,
      "orderCount": 123,
      "totalTouches": 123,
      "deviceCount": 123,
      "identities": {
        "email": "<string>",
        "phone": "<string>",
        "socials": [
          "<string>"
        ]
      }
    }
  }
}

Authorizations

Authorization · string · header · required

JWT token obtained from /api/auth/token endpoint. Token is verified using JWKS and must include a valid user identifier.

Path Parameters

projectId · string<uuid> · required

Query Parameters

cursor · string

Maximum string length: 500

limit · integer

Required range: 1 <= x <= 100

kinds · string

Comma-separated journey kinds: web, communication, engagement, commerce, lifecycle, advertising, system.

close_lead_id · string · required

Close lead id, for example lead_6ANU.

Required string length: 1 - 200

Response

200

application/json

Success

close_lead_id · string · required

matched · boolean · required

Whether this Close lead resolved to at least one tracked Sapt visitor.

match_method · enum<string> | null · required

Strongest resolution signal used: an exact stamped Close id, normalized email/phone, or a single-candidate first-touch fbclid.

Available options: close_lead_id, identity, fbclid, null

visitor_ids · string[] · required

Every first-party browser/device included in the returned journey.

journey · object · required

Show child attributes