Get Companies and Projects

Example requests of retrieving project within the application

    fetch("https://api.kruncher.ai/api/integration/projects", {
     method: "GET",
        headers: {
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
        }
        })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error("Error:", error));

import requests
 
url = "https://api.kruncher.ai/api/integration/projects"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
 
response = requests.get(url, headers=headers)
if response.status_code == 200:
data = response.json()
print(data)
else:
print("Error:", response.status_code, response.text)

• Method: GET
• URL: https://api.kruncher.ai/api/integration/projects
• Authorization: Use the API key as an authorization token.

The API will return all the projects in a paginated format.

Response Structure

The API response contains two main parts: Metadata and Data.

Metadata

• code: A string representing the status code of the response (e.g., "1000" for successful).
• title: A short description of the status (e.g., "Successful").
• description: A string for additional information or clarification (currently empty).

Data

An array of objects, each representing a different company or project. Each object contains detailed information:

• id: A unique identifier for the project.
• name: The name of the project.
• companyName: The name of the company associated with the project.
• companyLegalName: The legal name of the company.
• companyEmail: Contact email for the company.
• companyWebsite: The company’s website URL.
• companyIndustry: Industries the company is involved in.
• companyCountry: The country code of the company’s location.
• companyBusinessModel: The business model of the company (e.g., b2c for Business to Consumer).
• companyStage: The development stage of the company (e.g., preSeed).
• companyRevenueRange: The revenue range in which the company falls.
• isVisible, isPending, isUnread: Booleans indicating the visibility, pending status, and unread status of the project.
• processing: A string indicating the processing status of the project.
• projectUser: An object containing a role string (e.g., "contributor").

Analyses

An array of analysis objects, where each object includes:

• id: Unique identifier for the analysis.
• type: The type of analysis (e.g., "company").
• status: The status of the analysis (e.g., "completed", "progress").
• createdAt: Timestamp of when the analysis was created.

Project Scores

An array of score objects:

• status: Status of the score evaluation (e.g., "done").
• scoreText: A textual representation of the score.
• score: The numerical score assigned.

Project Status

Describes the status of the project:

• name
• code
• order
• isVisible
• hasProjectPhase: Various attributes describing the project status.

Project Phase

Similar to project status, with additional phase details:

• name
• code
• order
• isVisible

Project Owner

Information about the project owner:

• fullName
• email
• status: Details about the owner’s identity and status.

Pagination

Details about the pagination of the results:

• page: The current page number.
• totalCount: Total number of data records available.
• pageSize: Number of records per page.
• nextPage: A boolean indicating if there is a next page available.

This structured response is used in systems managing multiple projects or companies, providing detailed and paginated insights for users or applications interfacing with the API.