API Reference

Integrate ZuluIQ with your existing systems using our RESTful API

Base URL

https://api.zuluintelligence.com

Authentication

Bearer token in Authorization header

Rate Limits

1000 requests per hour per API key

GET/api/v1/leads

Retrieve a list of leads with optional filtering and pagination

Requires authentication

Parameters

Name	Type	Required	Description
`status`	string	Optional	Filter by lead status (HOT, WARM, COLD)
`from`	string	Optional	Start date for filtering (ISO 8601 format)
`to`	string	Optional	End date for filtering (ISO 8601 format)
`page`	integer	Optional	Page number for pagination (default: 1)
`limit`	integer	Optional	Number of results per page (default: 50, max: 100)

Code Example

curl -X GET "https://api.zuluintelligence.com/api/v1/leads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Successful response

{
  "success": true,
  "data": {
    "leads": [
      {
        "id": "lead_abc123",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com",
        "phone": "+1234567890",
        "status": "HOT",
        "score": 85,
        "createdAt": "2025-01-15T10:30:00Z",
        "lastActivity": "2025-01-15T10:35:00Z",
        "properties": {
          "budget": "$500,000 - $700,000",
          "timeline": "Within 3 months",
          "propertyType": "3-bedroom house",
          "location": "Downtown area"
        }
      }
    ],
    "pagination": {
      "total": 150,
      "page": 1,
      "pages": 3,
      "limit": 50
    }
  }
}

401Unauthorized - Invalid or missing API key

429Rate limit exceeded

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can generate API keys from your dashboard under Settings → API Keys.

Generate API Key →