GuidesAPI ReferenceZapier API
Leads

Get Lead Details

Retrieve detailed information for a specific lead and address information. Results are filtered by the organization associated with the API key.

GET
/v1/leads/{leadId}

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Path Parameters

leadId*string

The unique identifier of the lead

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.sophiie.ai/v1/leads/ld_abc123"
{
  "id": "ld_abc123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "suburb": "Downtown",
  "businessName": "Acme Corp",
  "socials": {},
  "status": "active",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "read": false,
  "lastInquiryId": "in_abc123",
  "lastInquiryDate": "2023-01-01T00:00:00.000Z",
  "unreadEmails": 0,
  "unreadCalls": 1,
  "unreadChatbotThreads": 0,
  "unreadSMS": 0,
  "unreadWebformSubmissions": 0,
  "hasFlaggedInquiry": false,
  "defaultLeadAddress": {
    "address": {
      "line1": "string",
      "line2": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "country": "string"
    }
  },
  "tags": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "lastInquiry": {
    "id": "string",
    "tag": "string",
    "summary": "string",
    "isFirstInquiry": true,
    "source": "string",
    "isRead": true
  }
}
{
  "success": false,
  "message": "Invalid or expired token",
  "error": {
    "status": 401,
    "message": "Invalid or expired token"
  }
}
{
  "success": false,
  "message": "Not found",
  "error": {
    "status": 404,
    "message": "Not found"
  }
}
{
  "success": false,
  "message": "Internal server error",
  "error": {
    "status": 500,
    "message": "Internal server error"
  }
}

Delete Lead DELETE

Soft delete a lead and related entities, sync deletion to external systems, and emit relevant webhooks. Only leads belonging to the organization associated with the API key can be deleted.

List Lead Activities GET

Retrieve a paginated list of activities for a specific lead. Returns activity data including event types, timestamps, and associated data. Results are filtered by the organization associated with the API key.