Read a lead you sent

One lead in the same scope as the list. Out of scope, unknown, or already declined is 404. A declined lead still replays its create 201, and this call is 404 after the decline.

GET/api/leads/{id}

Authorization

X-CM-API-KEYAPI key · headerrequired

Account key from Integrations. Keys use the cm_ prefix.

Path parameters

idstringrequired

Lead id returned when the lead was created.

min length 1

Responses

200

The lead.

idstringrequired

namestringrequired

emailstringrequired

phonestringrequired

locationstring | nullrequired

notesstring | nullrequired

categorystringrequired

servicestringrequired

leadIntentstringrequired

Allowed:hirenegotiationcomparison

sharedbooleanrequired

deliverystringrequired

Allowed:deliveredqueued

queuedReasonQueuedReason

Allowed:budget_exceededpayment_failed

originstringrequired

Allowed:networkhome_prepestimatordashboardsuresendcoapimcp

statusstringrequired

Stored status completed is returned as won.

Allowed:pendingcontactedattemptedToContactestimatingscheduledwonlost

partnerLeadPartyrequired

Show properties

idstringrequired

namestring | nullrequired

sentByLeadParty | nullrequired

Show properties

One of:

LeadParty

idstringrequired

namestring | nullrequired

null

null

jobValuenumber | nullrequired

createdAtstring<date-time>required

401

The key is missing or unknown.

errorstringrequired

403

The key cannot send leads.

errorstringrequired

404

The lead is outside this key, unknown, or already declined.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*Lead id returned when the lead was created.

Request

curl -X GET 'https://www.comarketing.com/api/leads/string' \
  -H 'X-CM-API-KEY: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://www.comarketing.com/api/leads/string", {
  method: "GET",
  headers: {
    "X-CM-API-KEY": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://www.comarketing.com/api/leads/string",
    headers={
        "X-CM-API-KEY": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "location": "string",
  "notes": "string",
  "category": "string",
  "service": "string",
  "leadIntent": "hire",
  "shared": true,
  "delivery": "delivered",
  "queuedReason": "budget_exceeded",
  "origin": "network",
  "status": "pending",
  "partner": {
    "id": "string",
    "name": "string"
  },
  "sentBy": {
    "id": "string",
    "name": "string"
  },
  "jobValue": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "error": "Invalid API key."
}

{
  "error": "This key cannot send leads."
}

{
  "error": "Lead not found."
}