GuidesAPI ReferenceZapier API
Leads

List Leads

Retrieve a paginated list of leads. Returns lead data including contact information, status, and inquiry statistics. Results are filtered by the organization associated with the API key.

GET
/v1/leads

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Query Parameters

page?integer

Page number for pagination

Default1
Range1 <= value
limit?integer

Number of items per page (max 100)

Default50
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.sophiie.ai/v1/leads"
{
  "leads": [
    {
      "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
    }
  ],
  "totalPages": 5,
  "currentPage": 1,
  "totalCount": 250
}
{
  "success": false,
  "message": "Invalid or expired token",
  "error": {
    "status": 401,
    "message": "Invalid or expired token"
  }
}
{
  "success": false,
  "message": "Internal server error",
  "error": {
    "status": 500,
    "message": "Internal server error"
  }
}

List Lead Notes GET

Retrieve a paginated list of notes for a specific lead. Returns note data including content, creation timestamps, and associated user information. Results are filtered by the organization associated with the API key.

Update Lead PUT

Update a new lead entry. The lead will be associated with the organization of the API key.