API docs by Redocly

Forager public API (1.0.0)

Download OpenAPI specification:Download

Forager public API endpoints documentation

datastorage

Job post event search

Job post event search.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
job_source
string (JobSourceEnum)
Enum: "indeed" "linkedin" "angellist"
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
date_featured_start
string <date>
date_featured_end
string <date>
organization_ids
Array of integers

To get a list of IDs use Organizations lookup endpoint.

title
string

This field supports a boolean text search query.

description
string

This field supports a boolean text search query.

is_remote
boolean or null
is_active
boolean
Default: true
locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

Responses

Request samples

Content type
{
  • "page": 0,
  • "job_source": "indeed",
  • "date_featured_start": "2019-08-24",
  • "date_featured_end": "2019-08-24",
  • "organization_ids": [
    ],
  • "title": "string",
  • "description": "string",
  • "is_remote": true,
  • "is_active": true,
  • "locations": [
    ],
  • "locations_exclude": [
    ]
}

Response samples

Content type
application/json
{
  • "search_results": [
    ],
  • "total_search_results": 0
}

Job post event search totals

Job post event search totals.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
job_source
string (JobSourceEnum)
Enum: "indeed" "linkedin" "angellist"
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
date_featured_start
string <date>
date_featured_end
string <date>
organization_ids
Array of integers

To get a list of IDs use Organizations lookup endpoint.

title
string

This field supports a boolean text search query.

description
string

This field supports a boolean text search query.

is_remote
boolean or null
is_active
boolean
Default: true
locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

Responses

Request samples

Content type
{
  • "page": 0,
  • "job_source": "indeed",
  • "date_featured_start": "2019-08-24",
  • "date_featured_end": "2019-08-24",
  • "organization_ids": [
    ],
  • "title": "string",
  • "description": "string",
  • "is_remote": true,
  • "is_active": true,
  • "locations": [
    ],
  • "locations_exclude": [
    ]
}

Response samples

Content type
application/json
{
  • "total_search_results": 0
}

Organization search

Organization search.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
organization_ids
Array of integers

To get a list of IDs use Organizations lookup endpoint.

description
string
locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

keywords
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

employees_start
integer
employees_end
integer
founded_date_start
string <date>
founded_date_end
string <date>
revenue_start
integer
revenue_end
integer
domains
Array of strings
domain_rank_start
integer
domain_rank_end
integer
domain_traffic_start
integer
domain_traffic_end
integer
web_technologies
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

linkedin_public_identifiers
Array of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_types
Array of strings (FundingTypesEnum)
Items Enum: "angel" "convertible_note" "corporate_round" "debt_financing" "equity_crowdfunding" "grant" "initial_coin_offering" "non_equity_assistance" "post_ipo_debt" "post_ipo_equity" "post_ipo_secondary" "pre_seed" "private_equity" "product_crowdfunding" "secondary_market" "seed" "series_a" "series_b" "series_c" "series_d" "series_e" "series_f" "series_g" "series_h" "series_i" "series_j" "series_unknown" "undisclosed"
funding_total_start
integer
funding_total_end
integer
funding_event_date_featured_start
string <date>
funding_event_date_featured_end
string <date>
job_post_title
string

This field supports a boolean text search query.

job_post_description
string

This field supports a boolean text search query.

job_post_is_remote
boolean or null
job_post_is_active
boolean or null
job_post_date_featured_start
string <date>
job_post_date_featured_end
string <date>
job_post_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_source
string (SimpleEventSourceEnum)
Enum: "product_hunt" "form_c_sec_gov" "form_d_sec_gov"
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
simple_event_reason
string (SimpleEventReasonEnum)
Enum: "report_released" "promoted_on_site"
  • report_released - Report released
  • promoted_on_site - Promoted on site
simple_event_date_featured_start
string <date>
simple_event_date_featured_end
string <date>

Responses

Request samples

Content type
{
  • "page": 0,
  • "organization_ids": [
    ],
  • "description": "string",
  • "locations": [
    ],
  • "industries": [
    ],
  • "industries_exclude": [
    ],
  • "keywords": [
    ],
  • "employees_start": 0,
  • "employees_end": 0,
  • "founded_date_start": "2019-08-24",
  • "founded_date_end": "2019-08-24",
  • "revenue_start": 0,
  • "revenue_end": 0,
  • "domains": [
    ],
  • "domain_rank_start": 0,
  • "domain_rank_end": 0,
  • "domain_traffic_start": 0,
  • "domain_traffic_end": 0,
  • "web_technologies": [
    ],
  • "linkedin_public_identifiers": [
    ],
  • "funding_types": [
    ],
  • "funding_total_start": 0,
  • "funding_total_end": 0,
  • "funding_event_date_featured_start": "2019-08-24",
  • "funding_event_date_featured_end": "2019-08-24",
  • "job_post_title": "string",
  • "job_post_description": "string",
  • "job_post_is_remote": true,
  • "job_post_is_active": true,
  • "job_post_date_featured_start": "2019-08-24",
  • "job_post_date_featured_end": "2019-08-24",
  • "job_post_locations": [
    ],
  • "job_post_locations_exclude": [
    ],
  • "simple_event_source": "product_hunt",
  • "simple_event_reason": "report_released",
  • "simple_event_date_featured_start": "2019-08-24",
  • "simple_event_date_featured_end": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "search_results": [
    ],
  • "total_search_results": 0
}

Organization search totals

Organization search totals.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
organization_ids
Array of integers

To get a list of IDs use Organizations lookup endpoint.

description
string
locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

keywords
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

employees_start
integer
employees_end
integer
founded_date_start
string <date>
founded_date_end
string <date>
revenue_start
integer
revenue_end
integer
domains
Array of strings
domain_rank_start
integer
domain_rank_end
integer
domain_traffic_start
integer
domain_traffic_end
integer
web_technologies
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

linkedin_public_identifiers
Array of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_types
Array of strings (FundingTypesEnum)
Items Enum: "angel" "convertible_note" "corporate_round" "debt_financing" "equity_crowdfunding" "grant" "initial_coin_offering" "non_equity_assistance" "post_ipo_debt" "post_ipo_equity" "post_ipo_secondary" "pre_seed" "private_equity" "product_crowdfunding" "secondary_market" "seed" "series_a" "series_b" "series_c" "series_d" "series_e" "series_f" "series_g" "series_h" "series_i" "series_j" "series_unknown" "undisclosed"
funding_total_start
integer
funding_total_end
integer
funding_event_date_featured_start
string <date>
funding_event_date_featured_end
string <date>
job_post_title
string

This field supports a boolean text search query.

job_post_description
string

This field supports a boolean text search query.

job_post_is_remote
boolean or null
job_post_is_active
boolean or null
job_post_date_featured_start
string <date>
job_post_date_featured_end
string <date>
job_post_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_source
string (SimpleEventSourceEnum)
Enum: "product_hunt" "form_c_sec_gov" "form_d_sec_gov"
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
simple_event_reason
string (SimpleEventReasonEnum)
Enum: "report_released" "promoted_on_site"
  • report_released - Report released
  • promoted_on_site - Promoted on site
simple_event_date_featured_start
string <date>
simple_event_date_featured_end
string <date>

Responses

Request samples

Content type
{
  • "page": 0,
  • "organization_ids": [
    ],
  • "description": "string",
  • "locations": [
    ],
  • "industries": [
    ],
  • "industries_exclude": [
    ],
  • "keywords": [
    ],
  • "employees_start": 0,
  • "employees_end": 0,
  • "founded_date_start": "2019-08-24",
  • "founded_date_end": "2019-08-24",
  • "revenue_start": 0,
  • "revenue_end": 0,
  • "domains": [
    ],
  • "domain_rank_start": 0,
  • "domain_rank_end": 0,
  • "domain_traffic_start": 0,
  • "domain_traffic_end": 0,
  • "web_technologies": [
    ],
  • "linkedin_public_identifiers": [
    ],
  • "funding_types": [
    ],
  • "funding_total_start": 0,
  • "funding_total_end": 0,
  • "funding_event_date_featured_start": "2019-08-24",
  • "funding_event_date_featured_end": "2019-08-24",
  • "job_post_title": "string",
  • "job_post_description": "string",
  • "job_post_is_remote": true,
  • "job_post_is_active": true,
  • "job_post_date_featured_start": "2019-08-24",
  • "job_post_date_featured_end": "2019-08-24",
  • "job_post_locations": [
    ],
  • "job_post_locations_exclude": [
    ],
  • "simple_event_source": "product_hunt",
  • "simple_event_reason": "report_released",
  • "simple_event_date_featured_start": "2019-08-24",
  • "simple_event_date_featured_end": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "total_search_results": 0
}

Person personal emails lookup

Do Person personal emails lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
person_id
integer
linkedin_public_identifier
string

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "linkedin_public_identifier": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Person phone numbers lookup

Do Person phone numbers lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
person_id
integer
linkedin_public_identifier
string

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "linkedin_public_identifier": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Person work emails lookup

Do Person work emails lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
person_id
integer
linkedin_public_identifier
string

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

do_contacts_enrichment
boolean
Default: false

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "linkedin_public_identifier": "string",
  • "do_contacts_enrichment": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Person detail lookup

Do Person details lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
person_id
integer
linkedin_public_identifier
string

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "linkedin_public_identifier": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "photo": "http://example.com",
  • "gender": "string",
  • "headline": "string",
  • "description": "string",
  • "skills": [
    ],
  • "location": {
    },
  • "linkedin_info": {
    },
  • "roles": [
    ],
  • "educations": [
    ]
}

Reverse lookup of person details by email

Do reverse lookup of person details by email.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
required
email
required
string <email>

Responses

Request samples

Content type
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "photo": "http://example.com",
  • "gender": "string",
  • "headline": "string",
  • "description": "string",
  • "skills": [
    ],
  • "location": {
    },
  • "linkedin_info": {
    },
  • "roles": [
    ],
  • "educations": [
    ]
}

Reverse lookup of person details by phone number

Do reverse lookup of person details by phone number.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
required
phone_number
required
string

Responses

Request samples

Content type
{
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "photo": "http://example.com",
  • "gender": "string",
  • "headline": "string",
  • "description": "string",
  • "skills": [
    ],
  • "location": {
    },
  • "linkedin_info": {
    },
  • "roles": [
    ],
  • "educations": [
    ]
}

Organization person role detail lookup

Do OrganizationPersonRole details lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
required
organization_person_role_id
required
integer

Responses

Request samples

Content type
{
  • "organization_person_role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_title": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "duration": "string",
  • "description": "string",
  • "is_current": true,
  • "organization": {
    },
  • "person": {
    },
  • "date_updated": "2019-08-24T14:15:22Z"
}

Organization person role search

Do search.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
role_title
string

This field supports a boolean text search query.

role_description
string

This field supports a boolean text search query.

role_is_current
boolean
Default: true
role_position_start_date
string <date>
role_position_end_date
string <date>
role_years_on_position_start
integer
role_years_on_position_end
integer
person_name
string

This field supports a boolean text search query.

person_headline
string

This field supports a boolean text search query.

person_description
string

This field supports a boolean text search query.

person_skills
Array of integers

To get a list of IDs use Person skills lookup endpoint.

person_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

person_industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

person_industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

person_linkedin_public_identifiers
Array of strings

LinkedIn person "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

organizations
Array of integers

To get a list of IDs use Organizations lookup endpoint.

organizations_bulk_domain
string
organization_domains
Array of strings
organization_description
string

This field supports a boolean text search query.

organization_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

organization_industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

organization_industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

organization_keywords
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

organization_web_technologies
Array of integers

To get a list of IDs use Web technologies lookup endpoint.

organization_founded_date_start
string <date>
organization_founded_date_end
string <date>
organization_employees_start
integer
organization_employees_end
integer
organization_revenue_start
integer
organization_revenue_end
integer
organization_domain_rank_start
integer
organization_domain_rank_end
integer
organization_linkedin_public_identifiers
Array of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_types
Array of strings (FundingTypesEnum)
Items Enum: "angel" "convertible_note" "corporate_round" "debt_financing" "equity_crowdfunding" "grant" "initial_coin_offering" "non_equity_assistance" "post_ipo_debt" "post_ipo_equity" "post_ipo_secondary" "pre_seed" "private_equity" "product_crowdfunding" "secondary_market" "seed" "series_a" "series_b" "series_c" "series_d" "series_e" "series_f" "series_g" "series_h" "series_i" "series_j" "series_unknown" "undisclosed"
funding_total_start
integer
funding_total_end
integer
funding_event_date_featured_start
string <date>
funding_event_date_featured_end
string <date>
job_post_title
string

This field supports a boolean text search query.

job_post_description
string

This field supports a boolean text search query.

job_post_is_remote
boolean or null
job_post_is_active
boolean or null
job_post_date_featured_start
string <date>
job_post_date_featured_end
string <date>
job_post_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_source
string (SimpleEventSourceEnum)
Enum: "product_hunt" "form_c_sec_gov" "form_d_sec_gov"
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
simple_event_reason
string (SimpleEventReasonEnum)
Enum: "report_released" "promoted_on_site"
  • report_released - Report released
  • promoted_on_site - Promoted on site
simple_event_date_featured_start
string <date>
simple_event_date_featured_end
string <date>

Responses

Request samples

Content type
{
  • "page": 0,
  • "role_title": "string",
  • "role_description": "string",
  • "role_is_current": true,
  • "role_position_start_date": "2019-08-24",
  • "role_position_end_date": "2019-08-24",
  • "role_years_on_position_start": 0,
  • "role_years_on_position_end": 0,
  • "person_name": "string",
  • "person_headline": "string",
  • "person_description": "string",
  • "person_skills": [
    ],
  • "person_locations": [
    ],
  • "person_industries": [
    ],
  • "person_industries_exclude": [
    ],
  • "person_linkedin_public_identifiers": [
    ],
  • "organizations": [
    ],
  • "organizations_bulk_domain": "string",
  • "organization_domains": [
    ],
  • "organization_description": "string",
  • "organization_locations": [
    ],
  • "organization_industries": [
    ],
  • "organization_industries_exclude": [
    ],
  • "organization_keywords": [
    ],
  • "organization_web_technologies": [
    ],
  • "organization_founded_date_start": "2019-08-24",
  • "organization_founded_date_end": "2019-08-24",
  • "organization_employees_start": 0,
  • "organization_employees_end": 0,
  • "organization_revenue_start": 0,
  • "organization_revenue_end": 0,
  • "organization_domain_rank_start": 0,
  • "organization_domain_rank_end": 0,
  • "organization_linkedin_public_identifiers": [
    ],
  • "funding_types": [
    ],
  • "funding_total_start": 0,
  • "funding_total_end": 0,
  • "funding_event_date_featured_start": "2019-08-24",
  • "funding_event_date_featured_end": "2019-08-24",
  • "job_post_title": "string",
  • "job_post_description": "string",
  • "job_post_is_remote": true,
  • "job_post_is_active": true,
  • "job_post_date_featured_start": "2019-08-24",
  • "job_post_date_featured_end": "2019-08-24",
  • "job_post_locations": [
    ],
  • "job_post_locations_exclude": [
    ],
  • "simple_event_source": "product_hunt",
  • "simple_event_reason": "report_released",
  • "simple_event_date_featured_start": "2019-08-24",
  • "simple_event_date_featured_end": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "search_results": [
    ],
  • "total_search_results": 0
}

Organization person role search totals

Organization person role search totals.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
page
integer
role_title
string

This field supports a boolean text search query.

role_description
string

This field supports a boolean text search query.

role_is_current
boolean
Default: true
role_position_start_date
string <date>
role_position_end_date
string <date>
role_years_on_position_start
integer
role_years_on_position_end
integer
person_name
string

This field supports a boolean text search query.

person_headline
string

This field supports a boolean text search query.

person_description
string

This field supports a boolean text search query.

person_skills
Array of integers

To get a list of IDs use Person skills lookup endpoint.

person_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

person_industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

person_industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

person_linkedin_public_identifiers
Array of strings

LinkedIn person "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

organizations
Array of integers

To get a list of IDs use Organizations lookup endpoint.

organizations_bulk_domain
string
organization_domains
Array of strings
organization_description
string

This field supports a boolean text search query.

organization_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

organization_industries
Array of integers

To get a list of IDs use Industries lookup endpoint.

organization_industries_exclude
Array of integers

To get a list of IDs use Industries lookup endpoint.

organization_keywords
Array of integers

To get a list of IDs use Organization keywords lookup endpoint.

organization_web_technologies
Array of integers

To get a list of IDs use Web technologies lookup endpoint.

organization_founded_date_start
string <date>
organization_founded_date_end
string <date>
organization_employees_start
integer
organization_employees_end
integer
organization_revenue_start
integer
organization_revenue_end
integer
organization_domain_rank_start
integer
organization_domain_rank_end
integer
organization_linkedin_public_identifiers
Array of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_types
Array of strings (FundingTypesEnum)
Items Enum: "angel" "convertible_note" "corporate_round" "debt_financing" "equity_crowdfunding" "grant" "initial_coin_offering" "non_equity_assistance" "post_ipo_debt" "post_ipo_equity" "post_ipo_secondary" "pre_seed" "private_equity" "product_crowdfunding" "secondary_market" "seed" "series_a" "series_b" "series_c" "series_d" "series_e" "series_f" "series_g" "series_h" "series_i" "series_j" "series_unknown" "undisclosed"
funding_total_start
integer
funding_total_end
integer
funding_event_date_featured_start
string <date>
funding_event_date_featured_end
string <date>
job_post_title
string

This field supports a boolean text search query.

job_post_description
string

This field supports a boolean text search query.

job_post_is_remote
boolean or null
job_post_is_active
boolean or null
job_post_date_featured_start
string <date>
job_post_date_featured_end
string <date>
job_post_locations
Array of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_exclude
Array of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_source
string (SimpleEventSourceEnum)
Enum: "product_hunt" "form_c_sec_gov" "form_d_sec_gov"
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
simple_event_reason
string (SimpleEventReasonEnum)
Enum: "report_released" "promoted_on_site"
  • report_released - Report released
  • promoted_on_site - Promoted on site
simple_event_date_featured_start
string <date>
simple_event_date_featured_end
string <date>

Responses

Request samples

Content type
{
  • "page": 0,
  • "role_title": "string",
  • "role_description": "string",
  • "role_is_current": true,
  • "role_position_start_date": "2019-08-24",
  • "role_position_end_date": "2019-08-24",
  • "role_years_on_position_start": 0,
  • "role_years_on_position_end": 0,
  • "person_name": "string",
  • "person_headline": "string",
  • "person_description": "string",
  • "person_skills": [
    ],
  • "person_locations": [
    ],
  • "person_industries": [
    ],
  • "person_industries_exclude": [
    ],
  • "person_linkedin_public_identifiers": [
    ],
  • "organizations": [
    ],
  • "organizations_bulk_domain": "string",
  • "organization_domains": [
    ],
  • "organization_description": "string",
  • "organization_locations": [
    ],
  • "organization_industries": [
    ],
  • "organization_industries_exclude": [
    ],
  • "organization_keywords": [
    ],
  • "organization_web_technologies": [
    ],
  • "organization_founded_date_start": "2019-08-24",
  • "organization_founded_date_end": "2019-08-24",
  • "organization_employees_start": 0,
  • "organization_employees_end": 0,
  • "organization_revenue_start": 0,
  • "organization_revenue_end": 0,
  • "organization_domain_rank_start": 0,
  • "organization_domain_rank_end": 0,
  • "organization_linkedin_public_identifiers": [
    ],
  • "funding_types": [
    ],
  • "funding_total_start": 0,
  • "funding_total_end": 0,
  • "funding_event_date_featured_start": "2019-08-24",
  • "funding_event_date_featured_end": "2019-08-24",
  • "job_post_title": "string",
  • "job_post_description": "string",
  • "job_post_is_remote": true,
  • "job_post_is_active": true,
  • "job_post_date_featured_start": "2019-08-24",
  • "job_post_date_featured_end": "2019-08-24",
  • "job_post_locations": [
    ],
  • "job_post_locations_exclude": [
    ],
  • "simple_event_source": "product_hunt",
  • "simple_event_reason": "report_released",
  • "simple_event_date_featured_start": "2019-08-24",
  • "simple_event_date_featured_end": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "total_search_results": 0,
  • "total_persons": 0,
  • "total_organizations": 0
}

WebSite detail lookup

Do WebSite detail lookup.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
Request Body schema:
domain
string
organization_id
integer
organization_linkedin_public_identifier
string

Responses

Request samples

Content type
{
  • "domain": "string",
  • "organization_id": 0,
  • "organization_linkedin_public_identifier": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain": "http://example.com",
  • "tranco_rank": 2147483647,
  • "similarweb_rank": 2147483647,
  • "similarweb_traffic": 9223372036854776000,
  • "website_technologies": [
    ]
}

subscriptions

Credits balance change logs list

CreditsBalanceChangeLog list view.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
query Parameters
date_created_end
string <date-time>
date_created_start
string <date-time>
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 15,
  • "next": 2,
  • "previous": null,
  • "results": [
    ]
}

Credits balance change logs list totals

Calculate the total of credits spent during the specified timeframe.

Authorizations:
Api-Key
path Parameters
account_id
required
integer
query Parameters
date_created_end
string <date-time>
date_created_start
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "total_credits_spent": 0
}

api_keys

List API keys

API view for managing API keys.

Authorizations:
Api-Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new API key

Handle creation of a new API key.

Authorizations:
Api-Key
Request Body schema:
name
string <= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "prefix": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string"
}

View API key details

API view for managing API keys.

Authorizations:
Api-Key
path Parameters
prefix
required
string

Responses

Response samples

Content type
application/json
{
  • "prefix": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string"
}

Delete API key

API view for managing API keys.

Authorizations:
Api-Key
path Parameters
prefix
required
string

Responses

users

View user information

A view to retrieve current user details.

Authorizations:
Api-Key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "accounts": [
    ]
}

objects-lookups

Industries lookup

Industries objects lookup.

query Parameters
q
required
string

Industry name.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Organizations lookup

Organizations objects lookup.

query Parameters
q
required
string

Organization name or domain.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Organization keywords lookup

Organization keywords objects lookup.

query Parameters
q
required
string

Organization keyword name.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Locations lookup

Locations objects lookup.

query Parameters
q
required
string

City, State, Country or Continent.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Person skills lookup

Person skills objects lookup.

query Parameters
q
required
string

Person skill name.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Web technologies lookup

Web technologies objects lookup.

query Parameters
q
required
string

Web technology name.

page
integer

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}