ClientSphereDocs
API reference/Leads

Get lead

Fetches a single lead by its id. Responds 404 if no lead with that id exists in the authenticated company.

GET
/leads/{id}

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Path Parameters

idRequiredstring

Resource ID

Format: "uuid"
curl -X GET "https://clientsphere.io/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Lead details

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phone": "string",
    "jobTitle": "string",
    "companyName": "string",
    "website": "string",
    "industry": "string",
    "companySize": "small",
    "stage": "new",
    "score": 100,
    "source": "website",
    "notes": "string",
    "tags": [
      "string"
    ],
    "assignedTo": 0,
    "disqualifiedReason": "bad_fit",
    "disqualifiedAt": "2019-08-24T14:15:22Z",
    "convertedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Previous

List leads GET

Next

Create lead POST