Skip to Content
Docs are evolving — expect frequent updates.
CompanyPortfolio Projects

Portfolio Projects

Retrieve all projects that are in your portfolio stage. Unlike the paginated Retrieve Companies endpoint, this returns all portfolio companies in a single response.

Endpoint

GET https://api.kruncher.ai/api/integration/portfolioprojects

Headers

HeaderRequiredDescription
AuthorizationYesYour API key (format: YOUR_API_KEY)

Code Examples

JavaScript/TypeScript

CODE
const API_KEY = "YOUR_API_KEY_HERE";
const BASE_URL = "https://api.kruncher.ai/api/integration";
 
const response = await fetch(`${BASE_URL}/portfolioprojects`, {
  headers: {
    "Authorization": API_KEY
  }
});
 
const result = await response.json();
const portfolioCompanies = result.data;
 
console.log(`Portfolio companies: ${portfolioCompanies.length}`);
portfolioCompanies.forEach(company => {
  const score = company.projectscores?.[0]?.score || "N/A";
  console.log(`  ${company.companyName} — Score: ${score}`);
});

Python

CODE
import requests
 
API_KEY = "YOUR_API_KEY_HERE"
BASE_URL = "https://api.kruncher.ai/api/integration"
 
headers = {
    "Authorization": API_KEY
}
 
response = requests.get(f"{BASE_URL}/portfolioprojects", headers=headers)
response.raise_for_status()
result = response.json()
 
portfolio_companies = result["data"]
 
print(f"Portfolio companies: {len(portfolio_companies)}")
for company in portfolio_companies:
    scores = company.get("projectscores", [])
    score = scores[0]["score"] if scores else "N/A"
    print(f"  {company['companyName']} — Score: {score}")

cURL

CODE
curl -s -X GET "https://api.kruncher.ai/api/integration/portfolioprojects" \
  -H "Authorization: YOUR_API_KEY_HERE"

Response Structure

Success Response (200 OK)

CODE
{
  "metadata": {
    "code": "1000",
    "title": "Successful",
    "description": ""
  },
  "data": [
    {
      "name": "TechStartup",
      "companyName": "TechStartup Inc.",
      "companyWebsite": "https://techstartup.com",
      "processing": "completed",
      "projectstatus": {
        "name": "Active",
        "code": "active"
      },
      "projectscores": [
        {
          "status": "done",
          "scoreText": "Strong Fit",
          "score": 8.5
        }
      ]
    },
    {
      "name": "HealthTech",
      "companyName": "HealthTech Ltd.",
      "companyWebsite": "https://healthtech.io",
      "processing": "completed",
      "projectstatus": {
        "name": "Active",
        "code": "active"
      },
      "projectscores": [
        {
          "status": "done",
          "scoreText": "Good Fit",
          "score": 7.2
        }
      ]
    }
  ]
}

Response Fields

FieldTypeDescription
namestringShort project name
companyNamestringFull company name
companyWebsitestringCompany website URL
processingstringProcessing status (completed, progress, pending)
projectstatusobjectCurrent project status
projectstatus.namestringStatus display name
projectstatus.codestringStatus code identifier
projectscoresarrayArray of score objects
projectscores[].statusstringScore calculation status
projectscores[].scoreTextstringHuman-readable score label
projectscores[].scorenumberNumerical score (typically 0-10)

Error Responses

401 Not Authorized

CODE
{
  "metadata": {
    "code": "106",
    "title": "Error",
    "description": "Not authorized"
  }
}

404 Not Found

CODE
{
  "metadata": {
    "code": "122",
    "title": "Error",
    "description": "API key not found"
  }
}

Last updated on