Complete API Reference

{
  "success": true,
  "data": {
    "user": {
      "id": "abc123",
      "email": "user@example.com"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many attempts"
  }
}

{
  "success": true,
  "data": {
    "user": {
      "id": "abc123",
      "email": "user@example.com",
      "name": "John Doe",
      "createdAt": "2024-01-01T00:00:00Z"
    },
    "stats": {
      "sources": 10,
      "jobs": 25,
      "leads": 500
    }
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

{
  "success": true
}

{
  "success": false,
  "error": {
    "code": "INVALID_PASSWORD",
    "message": "Current password is incorrect"
  }
}

{
  "success": true,
  "data": {
    "termsAccepted": true,
    "termsAcceptedAt": "2024-01-01T00:00:00Z",
    "privacyAccepted": true,
    "privacyAcceptedAt": "2024-01-01T00:00:00Z",
    "marketingConsent": false
  }
}

{
  "success": true,
  "data": {
    "marketingConsent": true,
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "success": true,
  "data": {
    "history": [
      {
        "id": "abc123",
        "action": "CONSENT_UPDATED",
        "details": {
          "marketingConsent": true
        },
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": {
      "total": 1,
      "limit": 50,
      "offset": 0
    }
  }
}

{
  "success": true,
  "data": {
    "requestId": "abc123",
    "status": "PENDING",
    "downloadExpiry": "2024-01-08T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Maximum 3 exports per week"
  }
}

{
  "success": true,
  "data": {
    "exports": [
      {
        "requestId": "abc123",
        "status": "COMPLETED",
        "format": "JSON",
        "createdAt": "2024-01-01T00:00:00Z",
        "downloadExpiry": "2024-01-08T00:00:00Z"
      }
    ]
  }
}

{
  "note": "Returns file attachment"
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Export not found or expired"
  }
}

{
  "success": true,
  "data": {
    "expiresAt": "2024-01-02T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "One deletion request per day"
  }
}

{
  "success": true,
  "data": {
    "scheduledAt": "2024-01-31T00:00:00Z",
    "gracePeriodDays": 30
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_TOKEN",
    "message": "Token is invalid or expired"
  }
}

{
  "success": true,
  "message": "Account deletion cancelled"
}

{
  "success": false,
  "error": {
    "code": "NO_PENDING_DELETION",
    "message": "No deletion request to cancel"
  }
}

{
  "success": true,
  "data": {
    "status": "scheduled",
    "scheduledAt": "2024-01-31T00:00:00Z",
    "gracePeriodDays": 30
  }
}

{
  "success": true,
  "data": {
    "projects": [
      {
        "id": "abc123",
        "name": "My Project",
        "description": "Project description",
        "color": "#3b82f6",
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "project": {
      "id": "abc123",
      "name": "My Project"
    }
  }
}

{
  "success": true,
  "data": {
    "project": {
      "id": "abc123",
      "name": "My Project"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Project not found"
  }
}

{
  "success": true,
  "data": {
    "project": {
      "id": "abc123",
      "name": "Updated Project"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Not authorized to update this project"
  }
}

{
  "success": true
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Not authorized to delete this project"
  }
}

{
  "success": true,
  "data": {
    "sources": [
      {
        "id": "abc123",
        "name": "Example Source",
        "url": "https://example.com",
        "scrapeType": "STATIC",
        "status": "ACTIVE"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "source": {
      "id": "abc123",
      "name": "Example Source",
      "status": "DRAFT"
    }
  }
}

{
  "success": true,
  "data": {
    "source": {
      "id": "abc123",
      "name": "Example Source"
    }
  }
}

{
  "success": true,
  "data": {
    "source": {
      "id": "abc123",
      "name": "Updated Source"
    }
  }
}

{
  "success": true
}

{
  "success": true,
  "data": {
    "source": {
      "id": "abc123",
      "status": "ACTIVE"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ALREADY_ACTIVE",
    "message": "Source is already active"
  }
}

{
  "success": true,
  "data": {
    "sources": [
      {
        "name": "Example Directory",
        "url": "https://example.com/directory",
        "category": "Business Directory",
        "estimatedLeads": 500,
        "scrapeType": "STATIC",
        "description": "A directory of local businesses",
        "reasoning": "This directory contains relevant business listings"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "sources": [
      {
        "name": "Industry Directory",
        "url": "https://example.com/directory",
        "description": "Relevant directory for target industry",
        "scrapeType": "STATIC",
        "reasoning": "Matches project requirements"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Project description must be at least 10 characters"
  }
}

{
  "success": true,
  "data": {
    "sources": [
      {
        "id": "abc123",
        "name": "Example Source",
        "status": "DRAFT"
      }
    ],
    "count": 1
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "At least one source is required"
  }
}

{
  "success": true,
  "data": {
    "requirements": {
      "targetAudience": "Small businesses",
      "industry": "Technology",
      "location": "United States",
      "suggestedSources": []
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Either file or url is required"
  }
}

{
  "success": true,
  "data": {
    "jobs": [
      {
        "id": "abc123",
        "name": "Scrape Job",
        "status": "COMPLETED",
        "progress": 100,
        "leadsFound": 150,
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "job": {
      "id": "abc123",
      "name": "Scrape Job",
      "status": "PENDING"
    }
  }
}

{
  "success": true,
  "data": {
    "job": {
      "id": "abc123",
      "status": "RUNNING",
      "progress": 45,
      "leadsFound": 67
    }
  }
}

{
  "success": true
}

{
  "success": true,
  "message": "Job retry started"
}

{
  "success": false,
  "error": {
    "code": "INVALID_STATUS",
    "message": "Only failed jobs can be retried"
  }
}

{
  "success": true,
  "data": {
    "leads": [
      {
        "id": "abc123",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com",
        "company": "Example Inc",
        "status": "VALID"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "lead": {
      "id": "abc123",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

{
  "success": true,
  "data": {
    "lead": {
      "id": "abc123",
      "email": "john@example.com"
    }
  }
}

{
  "success": true,
  "data": {
    "lead": {
      "id": "abc123"
    }
  }
}

{
  "success": true
}

{
  "success": true,
  "data": {
    "status": "VALID",
    "tier": "TIER_1",
    "errors": [],
    "flags": []
  }
}

{
  "success": false,
  "error": {
    "code": "NO_EMAIL",
    "message": "Lead has no email to validate"
  }
}

{
  "success": true,
  "data": {
    "deleted": 50,
    "failed": 0,
    "errors": []
  }
}

{
  "success": true,
  "data": {
    "updated": 50,
    "failed": 0
  }
}

{
  "success": true,
  "data": {
    "totalRequested": 100,
    "totalQueued": 95,
    "skipped": [
      {
        "id": "abc",
        "reason": "No email"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "profileTypes": [
      {
        "id": "pt_123",
        "name": "Private Lender",
        "slug": "private-lender",
        "fields": [],
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "id": "pt_123",
    "name": "Private Lender"
  }
}

{
  "success": true,
  "data": {}
}

{
  "success": true,
  "data": {}
}

{
  "success": true
}

{
  "success": true,
  "data": {
    "templates": [
      {
        "slug": "private-lender",
        "name": "Private Lender",
        "description": "Real estate lender schema"
      },
      {
        "slug": "restaurant",
        "name": "Restaurant",
        "description": "Food & beverage schema"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "profiles": [
      {
        "id": "prof_123",
        "profileTypeId": "pt_123",
        "data": {},
        "status": "NEW"
      }
    ],
    "total": 5
  }
}

{
  "success": true,
  "data": {}
}

{
  "success": true,
  "data": {}
}

{
  "Content-Type": "text/csv"
}

{
  "success": true,
  "data": {
    "total": 150,
    "byStatus": {
      "NEW": 80,
      "VERIFIED": 50,
      "OUTDATED": 15,
      "ARCHIVED": 5
    },
    "byProfileType": [
      {
        "profileTypeId": "pt_123",
        "count": 90
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "rules": [
      {
        "id": "rule_123",
        "name": "High-value Leads",
        "type": "SCORED",
        "profileTypeId": "pt_123"
      }
    ]
  }
}