Predictleads

https://docs.predictleads.com
Admin
Predictleads is a comprehensive business intelligence API platform that provides access to company...
Tokens:36,905
Snippets:364
Trust Score:8.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### CompaniesDataset Webhook Example

Source: https://docs.predictleads.com/schemas/open_api_schema.json

This example demonstrates the JSON payload received by the CompaniesDataset webhook, which is triggered when a followed company's redirect information changes. It includes company details and related entities.

```json
{
  "data": [
    {
      "id": "1cbead93-df5d-56c0-bb67-cfaf766d689b",
      "type": "company",
      "attributes": {
        "domain": "duckbill.com",
        "company_name": "Duckbill",
        "friendly_company_name": "Duckbill",
        "ticker": null,
        "meta_title": null,
        "meta_description": null,
        "description": null,
        "description_short": null,
        "language": null,
        "location": null,
        "location_data": [],
        "last_extraction_states": []
      },
      "relationships": {
        "redirects_to": {
          "data": {
            "id": "75f6fc24-3e86-5c77-b4cb-91dc7a825fe8",
            "type": "company"
          },
          "meta": {
            "reason": null
          }
        },
        "parent_company": {
          "data": null
        },
        "subsidiary_companies": {
          "data": []
        },
        "similar_companies": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "75f6fc24-3e86-5c77-b4cb-91dc7a825fe8",
      "type": "company",
      "attributes": {
        "domain": "macleancivilproducts.com",
        "company_name": "MacLean Civil Products",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.4",
    "record_state": "active"
  }
}
```

--------------------------------

### Get Companies Dataset

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Retrieves a dataset of companies with optional pagination.

```APIDOC
## GET /companies

### Description
Retrieves a dataset of companies. Supports pagination to manage the number of results returned.

### Method
GET

### Endpoint
/companies

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number of shown items. If not provided, the meta property `count` will be omitted from response for performance reasons.
- **limit** (integer) - Optional - Limit the number of shown items per page. Maximum value is 1000.

### Response
#### Success Response (200)
- **CompaniesDataset** - Schema reference for the companies dataset.

#### Error Responses
- **400** - BadRequestError: Invalid request body or parameters.
- **401** - UnauthorizedError: Authentication credentials are invalid or API subscription is not activated.
- **402** - PaymentRequiredError: Exceeded the monthly request limit.
- **403** - ForbiddenError: Request rate over limit.
- **404** - NotFoundError: Record not found.
- **422** - UnprocessableContentError: Provided data failed to validate.
- **429** - TooManyRequestsError: Too many requests. Includes a `Retry-After` header indicating how long to wait.
- **500** - InternalServerError: Internal server error.
```

--------------------------------

### Get Financing Events

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Retrieves a list of financing events for companies. You can filter by funding stage and company location.

```APIDOC
## GET /websites/predictleads

### Description
Retrieves a list of financing events for companies. You can filter by funding stage and company location.

### Method
GET

### Endpoint
/websites/predictleads

### Parameters
#### Query Parameters
- **funding_stage** (array) - Optional - The funding stage of the company. Accepted values are:
  - "pre_series_f"
  - "series_f_plus"
  - "series_f_plus_plus"
  - "series_f"
  - "series_f1"
  - "series_f2"
  - "series_f3"
  - "pre_series_g"
  - "series_g_plus"
  - "series_g_plus_plus"
  - "series_g"
  - "series_g1"
  - "series_g2"
  - "series_g3"
  - "pre_series_h"
  - "series_h_plus"
  - "series_h_plus_plus"
  - "series_h"
  - "series_h1"
  - "series_h2"
  - "series_h3"
  - "pre_series_i"
  - "series_i_plus"
  - "series_i_plus_plus"
  - "series_i"
  - "series_i1"
  - "series_i2"
  - "series_i3"
  - "pre_series_j"
  - "series_j_plus"
  - "series_j_plus_plus"
  - "series_j"
  - "series_j1"
  - "series_j2"
  - "series_j3"
  - "pre_angel_bridge"
  - "angel_plus_bridge"
  - "angel_plus_plus_bridge"
  - "angel_bridge"
  - "angel_1_bridge"
  - "angel_2_bridge"
  - "angel_3_bridge"
  - "pre_seed_bridge"
  - "seed_plus_bridge"
  - "seed_plus_plus_bridge"
  - "seed_bridge"
  - "seed_1_bridge"
  - "seed_2_bridge"
  - "seed_3_bridge"
  - "pre_series_a_bridge"
  - "series_a_plus_bridge"
  - "series_a_plus_plus_bridge"
  - "series_a_bridge"
  - "series_a1_bridge"
  - "series_a2_bridge"
  - "series_a3_bridge"
  - "pre_series_b_bridge"
  - "series_b_plus_bridge"
  - "series_b_plus_plus_bridge"
  - "series_b_bridge"
  - "series_b1_bridge"
  - "series_b2_bridge"
  - "series_b3_bridge"
  - "pre_series_c_bridge"
  - "series_c_plus_bridge"
  - "series_c_plus_plus_bridge"
  - "series_c_bridge"
  - "series_c1_bridge"
  - "series_c2_bridge"
  - "series_c3_bridge"
  - "pre_series_d_bridge"
  - "series_d_plus_bridge"
  - "series_d_plus_plus_bridge"
  - "series_d_bridge"
  - "series_d1_bridge"
  - "series_d2_bridge"
  - "series_d3_bridge"
  - "pre_series_e_bridge"
  - "series_e_plus_bridge"
  - "series_e_plus_plus_bridge"
  - "series_e_bridge"
  - "series_e1_bridge"
  - "series_e2_bridge"
  - "series_e3_bridge"
- **company_location** (string) - Optional - The response will include only companies located in the given country name or state name/abbreviation.
- **page** (integer) - Optional - Page number of shown items.
**NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for
performance reasons.
- **limit** (integer) - Optional - Limit the number of shown items per page.

### Responses
#### Success Response (200)
- **data** (array) - Description of the financing events dataset.

#### Error Response (400)
- **message** (string) - Description of the error.

#### Error Response (401)
- **message** (string) - Description of the error.
```

--------------------------------

### Get Company Job Openings

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Retrieve a list of job openings for a specific company, with options to filter by active status and date.

```APIDOC
## GET /companies/{company_id_or_domain}/job_openings

### Description
Retrieve a list of company's Job Openings.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/job_openings

### Parameters
#### Path Parameters
- **company_id_or_domain** (string) - Required - Company's ID or domain.

#### Query Parameters
- **active_only** (boolean) - Optional - Set to true if you'd like to receive JobOpenings that are not closed, have last_seen_at more recent than 5 days and were found in the last year.
- **not_closed** (boolean) - Optional - Similar to `active_only`, but without considering `last_seen_at` timestamp.
- **first_seen_at_from** (string) - Optional - Only return `JobOpenings` first seen after given date (ISO 8601).

### Responses
#### Success Response (200)
- **SimilarCompaniesDataset** - Schema reference for the successful response.

#### Error Responses
- **400** - Invalid request body or parameters.
- **401** - Authentication credentials are invalid or API subscription is not activated.
- **402** - Exceeded the monthly request limit.
- **403** - Request rate over limit.
- **404** - Record not found.
- **422** - Provided data failed to validate.
- **429** - Too many requests. Includes a `Retry-After` header indicating how long to wait.
```

--------------------------------

### Startup Platform Posts Dataset

Source: https://docs.predictleads.com/swagger

Endpoints for retrieving startup platform posts.

```APIDOC
## GET /discover/startup_platform_posts

### Description
Retrieve latest posts.

### Method
GET

### Endpoint
/discover/startup_platform_posts
```

--------------------------------

### Retrieve Latest Startup Platform Posts

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of the most recent posts from popular startup platforms. This endpoint is useful for tracking companies that are hiring or announcing new products.

```APIDOC
## GET /discover/startup_platform_posts

### Description
Returns a list of latest posts on popular startup platforms by companies that are hiring or launching new products.

### Method
GET

### Endpoint
/discover/startup_platform_posts

### Parameters
#### Query Parameters
- **published_at_from** (string) - Optional - Only return `StartupPlatformPosts` published after given date (ISO 8601).
- **published_at_until** (string) - Optional - Only return `StartupPlatformPosts` published before given date (ISO 8601).
- **post_types** (array) - Optional - Comma-separated (,) `StartupPlatformPost` post types. Possible values: `show_hn`, `job_hn`.
- **page** (integer) - Optional - Page number of shown items. Defaults to 1.
- **limit** (integer) - Optional - Limit the number of shown items per page. Defaults to 30, maximum 1000.

### Response
#### Success Response (200)
- **data** (array) - List of startup platform posts.
- **meta** (object) - Metadata about the response, including pagination information.

#### Response Example
{
  "data": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "platform": "string",
      "published_at": "string",
      "post_type": "string"
    }
  ],
  "meta": {
    "count": 1000,
    "next_page": "string"
  }
}
```

--------------------------------

### Retrieve a list of Products

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of products, allowing filtering by source and discovery date. Supports pagination and limiting results.

```APIDOC
## GET /discover/products/latest

### Description
Retrieves a list of Products filtered by a source on a website (e.g. "pricing" for "Pricing Page" and/or "menu" for "Menu") and/or date when the Product was discovered.

### Method
GET

### Endpoint
/discover/products/latest

### Parameters
#### Query Parameters
- **sources** (array) - Optional - Comma-separated (,) `Product` sources. Allowed values: `menu`, `pricing`.
- **first_seen_at_from** (string) - Optional - Only return `Products` first seen after given date (ISO 8601). Example: `2024-09-25`.
- **first_seen_at_until** (string) - Optional - Only return `Products` first seen before given date (ISO 8601). Example: `2024-09-25`.
- **page** (integer) - Optional - Page number of shown items. Default: 1. Minimum: 1.
- **limit** (integer) - Optional - Limit the number of shown items per page. Default: 30. Maximum: 1000.

### Response
#### Success Response (200)
- **schema** - Refers to `#/components/schemas/ProductsDataset`.

#### Error Responses
- **400** - Invalid request body or parameters.
- **401** - Authentication credentials are invalid or API subscription is not activated.
- **403** - Forbidden.
- **404** - Record not found.
- **422** - Provided data failed to validate.
- **429** - Too many requests. Includes `Retry-After` header.
```

--------------------------------

### Get Company News and Events

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Retrieves a list of news and events related to companies, with filtering options for event types, locations, and pagination.

```APIDOC
## GET /websites/predictleads

### Description
Retrieves a list of news and events related to companies. You can filter by specific event types, company locations, and control pagination.

### Method
GET

### Endpoint
/websites/predictleads

### Parameters
#### Query Parameters
- **event_type** (string) - Optional - Filters results to include only companies associated with the specified event type. Possible values include: `new_offering`, `launches`, `ends_partnership_with`, `partners_with`, `receives_award`, `recognized_as`, `identified_as_competitor_of`, `spins_off_company`, `spins_off_division`.
- **company_location** (string) - Optional - The response will include only companies located in the given country name or state name/abbreviation.
- **page** (integer) - Optional - Page number of shown items. Defaults to 1. If not provided, the `count` meta property will be omitted from the response for performance reasons.
- **limit** (integer) - Optional - Limits the number of shown items per page. Defaults to 30, with a maximum of 1000.

### Responses
#### Success Response (200)
- **NewsEventsDataset** (object) - Schema for the news and events data.

#### Response Example
{
  "example": "response body"
}

#### Error Response (400)
- **BadRequestError** (object) - Schema for bad request errors.

#### Error Response (401)
- **AuthenticationError** (object) - Schema for authentication errors.
```

--------------------------------

### Retrieve a single Product by ID

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a specific product's details using its unique identifier. This is useful for displaying detailed information about a particular product.

```APIDOC
## GET /products/{id}

### Description
Returns a single Product.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Product's ID.

### Responses
#### Success Response (200)
- **ProductsDataset** (object) - Request was successfully processed.

#### Error Responses
- **400** - Invalid request body or parameters.
- **401** - Authentication credentials are invalid or API subscription is not activated.
- **402** - Exceeded the monthly request limit.
- **403** - Request rate over limit.
```

--------------------------------

### Products Dataset

Source: https://docs.predictleads.com/swagger

Endpoints for retrieving product information.

```APIDOC
## GET /companies/{company_id_or_domain}/products

### Description
Retrieve company's Products.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/products
```

```APIDOC
## GET /products/{id}

### Description
Retrieve a single Product by ID.

### Method
GET

### Endpoint
/products/{id}
```

```APIDOC
## GET /discover/products/latest

### Description
Retrieve a list of Products.

### Method
GET

### Endpoint
/discover/products/latest
```

--------------------------------

### ApiSubscription

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Provides the current subscription status along with monthly credit limits and usage details.

```APIDOC
## ApiSubscription

### Description
Provides the current subscription status along with monthly credit limits and usage details.

### Attributes
- **status** (string) - The status of the current subscription. Enum: `disabled`, `active`, `disabled_due_to_error`.
- **monthly_credits_quota** (integer) - The number of credits available per month for the current subscription.
- **monthly_credits_used** (integer) - The number of credits used per month for the current subscription.

### Meta
- **schema_version** (string) - Represents schema version of objects.

### Example
```json
{
  "data": [
    {
      "id": "ea20b0c1-3427-4004-91e6-59a27be0c9ed",
      "type": "api_subscription",
      "attributes": {
        "status": "active",
        "monthly_credits_quota": 100,
        "monthly_credits_used": 42
      }
    }
  ],
  "meta": {
    "schema_version": "3.0"
  }
}
```
```

--------------------------------

### List Job Openings

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Retrieves a list of job openings with various filtering and pagination options.

```APIDOC
## GET /websites/predictleads

### Description
Retrieves a list of job openings based on specified criteria.

### Method
GET

### Endpoint
/websites/predictleads

### Parameters
#### Query Parameters
- **first_seen_at_from** (string) - Optional - Only return `JobOpenings` first seen after given date (ISO 8601).
- **first_seen_at_until** (string) - Optional - Only return `JobOpenings` first seen before given date (ISO 8601).
- **last_seen_at_from** (string) - Optional - Only return `JobOpenings` last seen after given date (ISO 8601).
- **last_seen_at_until** (string) - Optional - Only return `JobOpenings` last seen before given date (ISO 8601).
- **with_description_only** (boolean) - Optional - Only return JobOpenings that have description.
- **with_location_only** (boolean) - Optional - Only return JobOpenings that have location.
- **categories** (array) - Optional - Comma-separated (,) `JobOpening` categories. Allowed values: administration, consulting, data_analysis, design, directors, education, engineering, finance, healthcare_services, human_resources, information_technology, internship, legal, management, marketing, military_and_protective_services, operations, purchasing, product_management, quality_assurance, real_estate, research, sales, software_development, support, manual_work, food.
- **page** (integer) - Optional - Page number of shown items. Default: 1. Minimum: 1.
- **limit** (integer) - Optional - Limit the number of shown items per page. Default: 100. Maximum: 1000.

### Response
#### Success Response (200)
- **schema** - The schema for the JobOpeningsDataset.

#### Response Example
{
  "example": "response body"
}

#### Error Response (400)
- **schema** - The schema for BadRequestError.

#### Error Response (401)
- **schema** - The schema for UnauthorizedError.

#### Error Response (402)
- **schema** - Indicates that the monthly request limit has been exceeded.
```

--------------------------------

### Responses.FollowSuccessful

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Details the structure of a successful follow operation response.

```APIDOC
## Responses.FollowSuccessful

### Description
This object indicates that a company has been successfully followed.

### Properties
- **success** (object) - Required - Information about the successful follow operation.
  - **type** (string) - Required - Must be `follow_successful`.
  - **message** (string) - Required - A message confirming the successful follow.

### Example
```json
{
  "success": {
    "type": "follow_successful",
    "message": "Company with domain hubspot.com was successfully followed."
  }
}
```
```

--------------------------------

### Receive Job Openings

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Sends a list containing a single followed company's Job Opening. This is triggered when a job opening is found or closed.

```APIDOC
## POST /websites/predictleads

### Description
Receives a list containing a single followed company's Job Opening. This endpoint is triggered when a job opening is found or closed.

### Method
POST

### Endpoint
/websites/predictleads

### Request Body
- **data** (array) - Required - A list of job opening objects.
  - **id** (string) - Required - The unique identifier for the job opening.
  - **type** (string) - Required - The type of the object, expected to be 'job_opening'.
  - **attributes** (object) - Required - Contains the details of the job opening.
    - **title** (string) - Required - The title of the job opening.
    - **translated_title** (string or null) - Optional - The translated title of the job opening.
    - **normalized_title** (string) - Required - The normalized title of the job opening.
    - **description** (string) - Required - A detailed description of the job opening.
    - **url** (string) - Required - The URL to the job opening.
    - **first_seen_at** (string) - Required - The timestamp when the job opening was first seen.
    - **last_seen_at** (string) - Required - The timestamp when the job opening was last seen.
    - **last_processed_at** (string) - Required - The timestamp when the job opening was last processed.
    - **contract_types** (array of strings) - Required - A list of contract types for the job (e.g., "full_time").
    - **categories** (array of strings) - Required - A list of categories the job belongs to (e.g., "software_development").
    - **onet_data** (object) - Required - Contains O*NET data for the job.
      - **code** (string) - Required - The O*NET code.
      - **family** (string) - Required - The O*NET family.
      - **occupation_name** (string) - Required - The O*NET occupation name.
    - **posted_at** (string or null) - Optional - The timestamp when the job was posted.

### Request Example
```json
{
  "data": [
    {
      "id": "4d5ac23c-5824-427d-96c6-4e8d50a4241a",
      "type": "job_opening",
      "attributes": {
        "title": "AI Engineer",
        "translated_title": null,
        "normalized_title": "AI Engineer",
        "description": "# AI Engineer\n\n$50K - $120K•0.10% - 0.50%•London, England, GB\n\n**Job type**\n\nFull-time\n\n**Role**\n\nEngineering, Machine learning\n\n**Experience**\n\nAny (new grads ok)\n\n**Visa**\n\nUS citizenship/visa not required\n\nApply to Terra API and hundreds of other fast-growing YC startups with a single profile.\n\nApply to role ›\n\n## About the role\n\nWe work in super small teams, with extremely high velocity.\n\nWe are building multiple AI products, such as OdinAI, Graph API, and many more\n\nAs an AI engineer, you'll work in a small team, with maximum autonomy.\n\n* Be behind the curtain, creating, testing, and implementing AI models\n* Engage in data analysis, machine learning, and natural language processing.\n* Fine-tuning the AI's performance\n  and many more\n\nPreferred background:\n\nBachelor's or Master's degree in STEM.\nStrong technical skills (e.g. familiarity with a programming language such as Python, JavaScript, or Ruby)\nExperience with growth marketing, product development, and user acquisition/retention\n\n**Must haves.**\n\n-Must have done this before, or be willing to learn fast.\n\n-Must be fast. We operate at 200mph, and so do you.\n\n-Must be relentless. We never stop, so you are even faster than us.\n\n-Must have customer driven. We think customers first and so should you.\n\n-Must be driven and go above and beyond.\n\n-Must be able to explain and communicate clearly.\n\n-Must be prepared to challenge us and disagree. We are thinking and acting as a team.\n\n-Must be able to work autonomously.\n\n-Must want to work hard.\n\n-Last but not least, you are genuinely a nice person.\n\n**Big plus** You are an athlete, or care about quantifying your data\n\n## About Terra API\n\n## What we do\n\nTerra is the infrastructure layer for health data access.\n\nHealth data is trapped across hundreds of siloed sources: wearables, sensors, health apps, medical devices, blood tests, team systems, and clinical platforms. Every source has its own authentication, permissions, schema, latency, edge cases, and reliability problems.\n\nTerra abstracts all of that into one platform.\n\nWe give companies a single way to connect to health data, normalize it, stream it, analyze it, and build products on top of it. Today, Terra powers some of the top health companies in the world, as well as leading AI labs building the next generation of health intelligence.\n\nWe deliver more than 30 billion activities per year through infrastructure built for scale, security, and reliability.\n\n## Vision\n\nThe future of health is extreme personalization.\n\nHealth will move from care plans to goal setting: living to 120, winning the Olympics, becoming sharper, reversing disease, or performing at the top of any field.\n\nAI will help people understand themselves, predict outcomes 10 years ahead, and choose what they want to become.\n\nTo do that, AI needs continuous, permissioned, real-time health data from every source.\n\nTerra is building the infrastructure that makes this possible.\n\nTerra API\n\nFounded:2021\n\nBatch:W21\n\nTeam Size:25\n\nStatus:Active\n\nLocation:London, United Kingdom",
        "url": "https://www.ycombinator.com/companies/terra-api/jobs/0f5CP0r-ai-engineer",
        "first_seen_at": "2025-10-17T19:11:22Z",
        "last_seen_at": "2026-05-09T07:16:04Z",
        "last_processed_at": "2026-05-07T19:57:55Z",
        "contract_types": [
          "full_time"
        ],
        "categories": [
          "software_development",
          "data_analysis"
        ],
        "onet_data": {
          "code": "15-1299.08",
          "family": "Computer and Mathematical",
          "occupation_name": "Computer Systems Engineers/Architects"
        },
        "posted_at": null
      }
    }
  ]
}
```

```

--------------------------------

### Retrieve company's Website Evolution

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of a company's website evolution data. This includes information about subpages and their first seen dates. Supports filtering by date ranges and pagination.

```APIDOC
## GET /companies/{company_id_or_domain}/website_evolution

### Description
Returns a list of company's Website Evolution.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/website_evolution

### Parameters
#### Path Parameters
- **company_id_or_domain** (string) - Required - Company's ID or domain.

#### Query Parameters
- **first_seen_at_from** (string) - Optional - Only return `Subpages` first seen after given date (ISO 8601). Example: 2024-09-25
- **first_seen_at_until** (string) - Optional - Only return `Subpages` first seen before given date (ISO 8601). Example: 2024-09-25
- **page** (integer) - Optional - Page number of shown items. Default: 1. Minimum: 1
- **limit** (integer) - Optional - Limit the number of shown items per page. Default: 100. Maximum: 1000

### Responses
#### Success Response (200)
- **WebsiteEvolutionDataset** - Schema reference for the website evolution data.

#### Error Responses
- **400** - Invalid request body or parameters.
- **401** - Authentication information is missing or invalid.
- **402** - Exceeded the monthly request limit.
- **403** - Request rate over limit.
- **404** - Record not found.
- **422** - Provided data failed to validate.
- **429** - Too many requests. Includes a `Retry-After` header indicating how long to wait before making a new request (in seconds).
- **500** - Internal server error.
```

--------------------------------

### Website Evolution Dataset

Source: https://docs.predictleads.com/swagger

Endpoints for retrieving website evolution data for companies.

```APIDOC
## GET /companies/{company_id_or_domain}/website_evolution

### Description
Retrieve company's Website Evolution.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/website_evolution
```

--------------------------------

### Retrieve a single Job Opening by ID

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a specific job opening using its unique identifier. This endpoint is part of the Job Openings Dataset.

```APIDOC
## GET /job_openings/{id}

### Description
Returns a single Job Opening.

### Method
GET

### Endpoint
/job_openings/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - JobOpening's ID.

### Responses
#### Success Response (200)
- **schema** (object) - Request was successfully processed.

#### Error Responses
- **400** (object) - Invalid request body or parameters.
- **401** (object) - Authentication credentials are invalid or API subscription is not activated.
- **402** (object) - Exceeded the monthly request limit.
- **403** (object) - Request rate over limit.
- **404** (object) - Record not found.
- **422** (object) - Provided data failed to validate.
- **429** (object) - Too many requests. Includes `Retry-After` header (integer) indicating seconds to wait.
```

--------------------------------

### Retrieve Portfolio Companies

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of Portfolio Companies from VC, accelerator, and incubator portfolio pages. Results are categorized as `investor` and ordered by `first_seen_at` in descending order.

```APIDOC
## GET /discover/portfolio_companies/connections

### Description
Returns the Portfolio Companies found on the portfolio pages of thousands of VCs, accelerators, and incubators, as a list of Connections categorized as `investor`, ordered by the `first_seen_at`, descending.

### Method
GET

### Endpoint
/discover/portfolio_companies/connections

### Parameters
#### Query Parameters
- **first_seen_at_from** (string) - Optional - Only return `TechnologyDetections` first seen after given date (ISO 8601).
- **first_seen_at_until** (string) - Optional - Only return `TechnologyDetections` first seen before given date (ISO 8601).
- **last_seen_at_from** (string) - Optional - Only return `TechnologyDetections` last seen after given date (ISO 8601).
- **last_seen_at_until** (string) - Optional - Only return `TechnologyDetections` last seen before given date (ISO 8601).
- **page** (integer) - Optional - Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. (default: 1)
- **limit** (integer) - Optional - Limit the number of shown items per page. (default: 30, maximum: 1000)

### Response
#### Success Response (200)
- **ConnectionsDataset** - (object) - Schema reference for ConnectionsDataset.

#### Response Example
{
  "example": null
}
```

--------------------------------

### Retrieve Financing Events

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of financing events. This endpoint allows filtering by normalized financing types and company location, and results are ordered by the updated date.

```APIDOC
## GET /discover/financing_events

### Description
Returns a list of Financing Events, optionally filtered by normalized financing type and company's location, ordered by updated date.

### Method
GET

### Endpoint
/discover/financing_events

### Parameters
#### Query Parameters
- **financing_types_normalized** (array) - Optional - Comma-separated (,) `FinancingEvent` normalized financing types.

```

--------------------------------

### FinancingEvent Object

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Represents a financing event, including details about its effective date, discovery time, categories, financing type, amount, and source URLs.

```APIDOC
## FinancingEvent Object

### Description
Represents a financing event, including details about its effective date, discovery time, categories, financing type, amount, and source URLs.

### Properties
- **id** (string) - The unique identifier for the `FinancingEvent` object (UUID format).
- **type** (string) - The type of the object, which is fixed to `financing_event`.
- **attributes** (object) - Contains the attributes of the `FinancingEvent`.
  - **effective_date** (string | null) - The date and time (ISO 8601 format) when the `FinancingEvent` occurred.
  - **found_at** (string) - The date and time (ISO 8601 format) when the `FinancingEvent` was first discovered.
  - **categories** (array) - An array of strings representing the categories of the `FinancingEvent`.
  - **financing_type** (string) - The normalized type of financing.
  - **financing_type_normalized** (string) - The normalized type of financing.
  - **amount** (object) - Details about the financing amount.
  - **amount_normalized** (object) - The normalized financing amount.
  - **source_urls** (array) - An array of URLs where the financing information was sourced.
- **relationships** (object) - Contains the relationships of the `FinancingEvent`.
```

--------------------------------

### Retrieve a single Technology by ID or fuzzy name

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a single Technology record using its unique ID or a fuzzy name match. This endpoint is useful for obtaining detailed information about a specific technology.

```APIDOC
## GET /technologies/{id_or_fuzzy_name}

### Description
Returns a single Technology.

### Method
GET

### Endpoint
/technologies/{id_or_fuzzy_name}

### Parameters
#### Path Parameters
- **id_or_fuzzy_name** (string) - Required - Technology's ID or fuzzy name.

### Response
#### Success Response (200)
- **schema** (TechnologiesDataset) - Description of the technology dataset.

#### Error Responses
- **400** - Invalid request body or parameters.
- **401** - Authentication credentials are invalid or API subscription is not activated.
- **402** - Exceeded the monthly request limit.
```

--------------------------------

### Retrieve Company's Github Repositories

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of Github repositories associated with a specific company. You can filter the results by the date the repositories were first seen and control pagination.

```APIDOC
## GET /companies/{company_id_or_domain}/github_repositories

### Description
Returns a list of company's Github Repositories.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/github_repositories

### Parameters
#### Path Parameters
- **company_id_or_domain** (string) - Required - Company's ID or domain.

#### Query Parameters
- **first_seen_at_from** (string) - Optional - Only return `GithubRepositories` first seen after given date (ISO 8601).
- **first_seen_at_until** (string) - Optional - Only return `GithubRepositories` first seen before given date (ISO 8601).
- **page** (integer) - Optional - Page number of shown items. Default: 1. Minimum: 1.
- **limit** (integer) - Optional - Limit the number of shown items per page. Default: 100. Maximum: 1000.

### Response
#### Success Response (200)
- **schema** - Refers to `#/components/schemas/GithubRepositoriesDataset`
```

--------------------------------

### ConnectionsDataset POST

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Sends a list containing a single followed company's Connection. This endpoint is triggered when a connection is found.

```APIDOC
## POST /ConnectionsDataset

### Description
Receives a list of followed company connections.

### Method
POST

### Endpoint
/ConnectionsDataset

### Request Body
- **data** (array) - Required - A list of connection objects.
  - **id** (string) - Required - The unique identifier for the connection.
  - **type** (string) - Required - The type of the object, should be "connection".
  - **attributes** (object) - Required - Attributes of the connection.
    - **category** (string) - Required - The category of the connection.
    - **source_category** (string) - Required - The source category of the connection.
    - **source_url** (string) - Required - The URL of the source.
    - **individual_source_url** (string) - Required - The individual source URL.
    - **context** (string) - Required - Contextual information about the connection.
    - **first_seen_at** (string) - Required - Timestamp when the connection was first seen.
    - **last_seen_at** (string) - Required - Timestamp when the connection was last seen.
  - **relationships** (object) - Required - Relationships of the connection.
    - **company1** (object) - Required - The first company in the relationship.
      - **data** (object) - Required - Data for company1.
        - **id** (string) - Required - The unique identifier for company1.
        - **type** (string) - Required - The type of the object, should be "company".
    - **company2** (object) - Required - The second company in the relationship.
      - **data** (object) - Required - Data for company2.
        - **id** (string) - Required - The unique identifier for company2.
        - **type** (string) - Required - The type of the object, should be "company".
    - **technology** (object) - Optional - The technology associated with the connection.
      - **data** (object) - Optional - Data for the technology.
        - **id** (string) - Required - The unique identifier for the technology.
        - **type** (string) - Required - The type of the object, should be "technology".
- **included** (array) - Optional - Included objects, such as companies or technologies.
  - **id** (string) - Required - The unique identifier for the included object.
  - **type** (string) - Required - The type of the object (e.g., "company", "technology").
  - **attributes** (object) - Required - Attributes of the included object.
    - **domain** (string) - Optional - The domain of the company.
    - **company_name** (string) - Optional - The name of the company.
    - **ticker** (string) - Optional - The stock ticker symbol.
- **meta** (object) - Optional - Metadata about the request.
  - **schema_version** (string) - Required - The version of the schema.
  - **record_state** (string) - Required - The state of the record.

### Request Example
```json
{
  "data": [
    {
      "id": "587e4f3f-8149-4918-8a30-89190fa582f8",
      "type": "connection",
      "attributes": {
        "category": "integration",
        "source_category": "integration_page",
        "source_url": "https://y.uno/integrations",
        "individual_source_url": "https://www.y.uno/partner/adyen",
        "context": "Yuno partners with Adyen to integrate its global payment solutions, enhancing transaction processing capabilities and unlocking revenue opportunities for businesses. This collaboration ensures seamless integration with various payment providers and fraud solutions, fostering mutual success.",
        "first_seen_at": "2023-08-02T21:20:41Z",
        "last_seen_at": "2026-04-05T03:29:36Z"
      },
      "relationships": {
        "company1": {
          "data": {
            "id": "edb175f8-51be-53ef-8af5-bec04dc3a402",
            "type": "company"
          }
        },
        "company2": {
          "data": {
            "id": "94d705f4-6650-5055-b643-62d0740cdfa3",
            "type": "company"
          }
        },
        "technology": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "edb175f8-51be-53ef-8af5-bec04dc3a402",
      "type": "company",
      "attributes": {
        "domain": "y.uno",
        "company_name": "Yuno Group",
        "ticker": null
      }
    },
    {
      "id": "94d705f4-6650-5055-b643-62d0740cdfa3",
      "type": "company",
      "attributes": {
        "domain": "adyen.com",
        "company_name": "Adyen",
        "ticker": "AMS:ADYEN"
      }
    }
  ],
  "meta": {
    "schema_version": "3.1",
    "record_state": "active"
  }
}
```

### Response
#### Success Response (200)
- **description** (string) - Indicates that the data was received successfully.
```

--------------------------------

### Job Openings Dataset

Source: https://docs.predictleads.com/swagger

Endpoints for retrieving job openings.

```APIDOC
## GET /companies/{company_id_or_domain}/job_openings

### Description
Retrieve company's Job Openings.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/job_openings
```

```APIDOC
## GET /job_openings/{id}

### Description
Retrieve a single Job Opening by ID.

### Method
GET

### Endpoint
/job_openings/{id}
```

```APIDOC
## GET /discover/job_openings

### Description
Retrieve a list of Job Openings.

### Method
GET

### Endpoint
/discover/job_openings
```

--------------------------------

### Retrieve all tracked Technologies

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Fetches a list of all technologies currently tracked by the system. You can filter results by technology name and control the sorting and pagination of the returned data.

```APIDOC
## GET /technologies

### Description
Returns a list of all tracked Technologies.

### Method
GET

### Endpoint
/technologies

### Parameters
#### Query Parameters
- **fuzzy_name** (string) - Optional - Filter results based on Technology's fuzzy name.
- **order_by** (string) - Optional - Order of `TechnologiesDatasets`. Possible values: `created_at_asc`, `created_at_desc`, `fuzzy_score_desc` (only available when `fuzzy_name` parameter is provided). Defaults to `created_at_asc`.
- **page** (integer) - Optional - Page number of shown items. Defaults to 1.
- **limit** (integer) - Optional - Limit the number of shown items per page.
```

--------------------------------

### Follow Companies

Source: https://docs.predictleads.com/swagger

Endpoints for managing followed companies.

```APIDOC
## GET /followings

### Description
Retrieve followed companies.

### Method
GET

### Endpoint
/followings
```

```APIDOC
## POST /companies/{company_id_or_domain}/follow

### Description
Follow the company.

### Method
POST

### Endpoint
/companies/{company_id_or_domain}/follow
```

```APIDOC
## POST /companies/{company_id_or_domain}/unfollow

### Description
Unfollow the company.

### Method
POST

### Endpoint
/companies/{company_id_or_domain}/unfollow
```

--------------------------------

### JobOpeningsDataset Webhook

Source: https://docs.predictleads.com/schemas/open_api_schema.json

This webhook endpoint is used for receiving job opening data. The specific details of its triggers and payload are not fully detailed in the provided source.

```APIDOC
## POST /JobOpeningsDataset

### Description
Receives job opening data. The exact triggers and payload structure require further documentation.

### Method
POST

### Endpoint
/JobOpeningsDataset

### Response
#### Success Response (200)
Indicates successful receipt of data. Specific response body details are not provided in the source.
```

--------------------------------

### Retrieve Company's Similar Companies

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Returns a list of a company's similar companies, with reasons for similarity for the top 20.

```APIDOC
## GET /companies/{company_id_or_domain}/similar_companies

### Description
Returns a list of a company's Similar Companies and, for the top 20, provides a reason why they are considered similar.

### Method
GET

### Endpoint
/companies/{company_id_or_domain}/similar_companies

### Parameters
#### Path Parameters
- **company_id_or_domain** (string) - Required - Company's ID or domain.

#### Query Parameters
- **page** (integer) - Optional - Page number of shown items. If not provided, the meta property `count` will be omitted from response for performance reasons.

```

--------------------------------

### Response Schemas

Source: https://docs.predictleads.com/schemas/open_api_schema.json

Details the structure of successful responses for following and multiple followings.

```APIDOC
## Response Schemas

### Responses.Following

**Description:** Information about a single followed company.

**Properties:**
- `domain` (string) - The domain name of the company.
- `custom_company_identifier` (string, optional) - Your custom identifier for the company.

### Request Example
```json
{
  "domain": "hubspot.com",
  "custom_company_identifier": "35446"
}
```

### Responses.Followings

**Description:** Information about multiple followed companies.

**Properties:**
- `data` (array) - An array of followed company objects.
  - `items` (object) - Each item in the array is a `Responses.Following` object.

### Request Example
```json
{
  "data": [
    {
      "domain": "hubspot.com",
      "custom_company_identifier": "35446"
    }
  ]
}
```
```
Tokens:
Raw