Download OpenAPI specification:Download
Forager public API endpoints documentation
Job post event search.
account_id required | integer |
page | integer |
job_source | string (JobSourceEnum) Enum: "indeed" "linkedin" "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. |
{- "page": 0,
- "job_source": "indeed",
- "date_featured_start": "2019-08-24",
- "date_featured_end": "2019-08-24",
- "organization_ids": [
- 0
], - "title": "string",
- "description": "string",
- "is_remote": true,
- "is_active": true,
- "locations": [
- 0
], - "locations_exclude": [
- 0
]
}
{- "search_results": [
- {
- "id": 0,
- "source": "indeed",
- "date_featured": "2019-08-24",
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "source_id": "string",
- "title": "string",
- "description": "string",
- "is_remote": true,
- "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "is_active": true
}
], - "total_search_results": 0
}
Job post event search totals.
account_id required | integer |
page | integer |
job_source | string (JobSourceEnum) Enum: "indeed" "linkedin" "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. |
{- "page": 0,
- "job_source": "indeed",
- "date_featured_start": "2019-08-24",
- "date_featured_end": "2019-08-24",
- "organization_ids": [
- 0
], - "title": "string",
- "description": "string",
- "is_remote": true,
- "is_active": true,
- "locations": [
- 0
], - "locations_exclude": [
- 0
]
}
{- "total_search_results": 0
}
Organization search.
account_id required | integer |
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"
|
simple_event_reason | string (SimpleEventReasonEnum) Enum: "report_released" "promoted_on_site"
|
simple_event_date_featured_start | string <date> |
simple_event_date_featured_end | string <date> |
{- "page": 0,
- "organization_ids": [
- 0
], - "description": "string",
- "locations": [
- 0
], - "industries": [
- 0
], - "industries_exclude": [
- 0
], - "keywords": [
- 0
], - "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": [
- "string"
], - "domain_rank_start": 0,
- "domain_rank_end": 0,
- "domain_traffic_start": 0,
- "domain_traffic_end": 0,
- "web_technologies": [
- 0
], - "linkedin_public_identifiers": [
- "string"
], - "funding_types": [
- "angel"
], - "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": [
- 0
], - "job_post_locations_exclude": [
- 0
], - "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"
}
{- "search_results": [
- {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "domain_rank": 0,
- "description": "string",
- "founded_date": "2019-08-24",
- "operating_status": "string",
- "employees_range": "string",
- "employees_amount": 2147483647,
- "keywords": [
- {
- "id": 0,
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "finance_info": {
- "revenue": 9223372036854776000
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "addresses": [
- {
- "street_number": "string",
- "street_name": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "summary": "string"
}
], - "date_updated": "2019-08-24T14:15:22Z",
- "found_simple_events": [
- {
- "id": 0,
- "source": "product_hunt",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "reason": "report_released",
}
], - "found_funding_events": [
- {
- "id": 0,
- "source": "crunchbase",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "funding_type": "string",
- "funding_total": 9223372036854776000
}
], - "found_job_post_events": [
- {
- "id": 0,
- "source": "indeed",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "source_id": "string",
- "title": "string",
- "is_remote": true,
- "is_active": true
}
]
}
], - "total_search_results": 0
}
Organization search totals.
account_id required | integer |
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"
|
simple_event_reason | string (SimpleEventReasonEnum) Enum: "report_released" "promoted_on_site"
|
simple_event_date_featured_start | string <date> |
simple_event_date_featured_end | string <date> |
{- "page": 0,
- "organization_ids": [
- 0
], - "description": "string",
- "locations": [
- 0
], - "industries": [
- 0
], - "industries_exclude": [
- 0
], - "keywords": [
- 0
], - "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": [
- "string"
], - "domain_rank_start": 0,
- "domain_rank_end": 0,
- "domain_traffic_start": 0,
- "domain_traffic_end": 0,
- "web_technologies": [
- 0
], - "linkedin_public_identifiers": [
- "string"
], - "funding_types": [
- "angel"
], - "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": [
- 0
], - "job_post_locations_exclude": [
- 0
], - "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"
}
{- "total_search_results": 0
}
Do Person personal emails lookup.
account_id required | integer |
person_id | integer |
linkedin_public_identifier | string LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/". |
{- "person_id": 0,
- "linkedin_public_identifier": "string"
}
[- {
- "email": "user@example.com",
- "email_type": "string",
- "validation_status": "valid"
}
]
Do Person phone numbers lookup.
account_id required | integer |
person_id | integer |
linkedin_public_identifier | string LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/". |
{- "person_id": 0,
- "linkedin_public_identifier": "string"
}
[- {
- "phone_number": "string"
}
]
Do Person work emails lookup.
account_id required | integer |
person_id | integer |
linkedin_public_identifier | string LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/". |
do_contacts_enrichment | boolean Default: false |
{- "person_id": 0,
- "linkedin_public_identifier": "string",
- "do_contacts_enrichment": false
}
[- {
- "email": "user@example.com",
- "email_type": "string",
- "validation_status": "valid"
}
]
Do Person details lookup.
account_id required | integer |
person_id | integer |
linkedin_public_identifier | string LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/". |
{- "person_id": 0,
- "linkedin_public_identifier": "string"
}
{- "id": 0,
- "full_name": "string",
- "first_name": "string",
- "last_name": "string",
- "gender": "string",
- "headline": "string",
- "description": "string",
- "skills": [
- {
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "roles": [
- {
- "id": 0,
- "role_title": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "duration": "string",
- "description": "string",
- "is_current": true,
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "organization_name": "string"
}
], - "educations": [
- {
- "id": 0,
- "school_name": "string",
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "description": "string",
- "grade": "string",
- "degree": "string",
- "activities": "string",
- "field_of_study": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
Do reverse lookup of person details by email.
account_id required | integer |
email required | string <email> |
{- "email": "user@example.com"
}
{- "id": 0,
- "full_name": "string",
- "first_name": "string",
- "last_name": "string",
- "gender": "string",
- "headline": "string",
- "description": "string",
- "skills": [
- {
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "roles": [
- {
- "id": 0,
- "role_title": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "duration": "string",
- "description": "string",
- "is_current": true,
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "organization_name": "string"
}
], - "educations": [
- {
- "id": 0,
- "school_name": "string",
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "description": "string",
- "grade": "string",
- "degree": "string",
- "activities": "string",
- "field_of_study": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
Do reverse lookup of person details by phone number.
account_id required | integer |
phone_number required | string |
{- "phone_number": "string"
}
{- "id": 0,
- "full_name": "string",
- "first_name": "string",
- "last_name": "string",
- "gender": "string",
- "headline": "string",
- "description": "string",
- "skills": [
- {
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "roles": [
- {
- "id": 0,
- "role_title": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "duration": "string",
- "description": "string",
- "is_current": true,
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "organization_name": "string"
}
], - "educations": [
- {
- "id": 0,
- "school_name": "string",
- "organization": {
- "id": 0,
- "name": "string",
- "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}
}, - "description": "string",
- "grade": "string",
- "degree": "string",
- "activities": "string",
- "field_of_study": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24"
}
]
}
Do OrganizationPersonRole details lookup.
account_id required | integer |
organization_person_role_id required | integer |
{- "organization_person_role_id": 0
}
{- "id": 0,
- "role_title": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "duration": "string",
- "description": "string",
- "is_current": true,
- "organization": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "domain_rank": 0,
- "description": "string",
- "founded_date": "2019-08-24",
- "operating_status": "string",
- "employees_range": "string",
- "employees_amount": 2147483647,
- "keywords": [
- {
- "id": 0,
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "finance_info": {
- "revenue": 9223372036854776000
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "addresses": [
- {
- "street_number": "string",
- "street_name": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "summary": "string"
}
], - "date_updated": "2019-08-24T14:15:22Z"
}, - "person": {
- "id": 0,
- "full_name": "string",
- "first_name": "string",
- "last_name": "string",
- "gender": "string",
- "headline": "string",
- "description": "string",
- "skills": [
- {
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "date_updated": "2019-08-24T14:15:22Z"
}, - "date_updated": "2019-08-24T14:15:22Z"
}
Do search.
account_id required | integer |
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"
|
simple_event_reason | string (SimpleEventReasonEnum) Enum: "report_released" "promoted_on_site"
|
simple_event_date_featured_start | string <date> |
simple_event_date_featured_end | string <date> |
{- "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": [
- 0
], - "person_locations": [
- 0
], - "person_industries": [
- 0
], - "person_industries_exclude": [
- 0
], - "person_linkedin_public_identifiers": [
- "string"
], - "organizations": [
- 0
], - "organizations_bulk_domain": "string",
- "organization_domains": [
- "string"
], - "organization_description": "string",
- "organization_locations": [
- 0
], - "organization_industries": [
- 0
], - "organization_industries_exclude": [
- 0
], - "organization_keywords": [
- 0
], - "organization_web_technologies": [
- 0
], - "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": [
- "string"
], - "funding_types": [
- "angel"
], - "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": [
- 0
], - "job_post_locations_exclude": [
- 0
], - "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"
}
{- "search_results": [
- {
- "id": 0,
- "role_title": "string",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "duration": "string",
- "description": "string",
- "is_current": true,
- "organization": {
- "id": 0,
- "name": "string",
- "legal_name": "string",
- "domain_rank": 0,
- "description": "string",
- "founded_date": "2019-08-24",
- "operating_status": "string",
- "employees_range": "string",
- "employees_amount": 2147483647,
- "keywords": [
- {
- "id": 0,
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "finance_info": {
- "revenue": 9223372036854776000
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "addresses": [
- {
- "street_number": "string",
- "street_name": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "summary": "string"
}
], - "date_updated": "2019-08-24T14:15:22Z",
- "found_simple_events": [
- {
- "id": 0,
- "source": "product_hunt",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "reason": "report_released",
}
], - "found_funding_events": [
- {
- "id": 0,
- "source": "crunchbase",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "funding_type": "string",
- "funding_total": 9223372036854776000
}
], - "found_job_post_events": [
- {
- "id": 0,
- "source": "indeed",
- "date_featured": "2019-08-24",
- "organization_id": 0,
- "source_id": "string",
- "title": "string",
- "is_remote": true,
- "is_active": true
}
]
}, - "person": {
- "id": 0,
- "full_name": "string",
- "first_name": "string",
- "last_name": "string",
- "gender": "string",
- "headline": "string",
- "description": "string",
- "skills": [
- {
- "name": "string"
}
], - "location": {
- "id": 0,
- "name": "string",
- "osm_locations": [
- {
- "id": 0,
- "name": "string",
- "place_type": "string"
}
]
}, - "linkedin_info": {
- "public_identifier": "string",
- "industry": {
- "id": 0,
- "name": "string"
}, - "public_profile_url": "string"
}, - "date_updated": "2019-08-24T14:15:22Z"
}, - "date_updated": "2019-08-24T14:15:22Z"
}
], - "total_search_results": 0
}
Organization person role search totals.
account_id required | integer |
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"
|
simple_event_reason | string (SimpleEventReasonEnum) Enum: "report_released" "promoted_on_site"
|
simple_event_date_featured_start | string <date> |
simple_event_date_featured_end | string <date> |
{- "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": [
- 0
], - "person_locations": [
- 0
], - "person_industries": [
- 0
], - "person_industries_exclude": [
- 0
], - "person_linkedin_public_identifiers": [
- "string"
], - "organizations": [
- 0
], - "organizations_bulk_domain": "string",
- "organization_domains": [
- "string"
], - "organization_description": "string",
- "organization_locations": [
- 0
], - "organization_industries": [
- 0
], - "organization_industries_exclude": [
- 0
], - "organization_keywords": [
- 0
], - "organization_web_technologies": [
- 0
], - "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": [
- "string"
], - "funding_types": [
- "angel"
], - "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": [
- 0
], - "job_post_locations_exclude": [
- 0
], - "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"
}
{- "total_search_results": 0,
- "total_persons": 0,
- "total_organizations": 0
}
Do WebSite detail lookup.
account_id required | integer |
domain | string |
organization_id | integer |
organization_linkedin_public_identifier | string |
{- "domain": "string",
- "organization_id": 0,
- "organization_linkedin_public_identifier": "string"
}
{- "id": 0,
- "tranco_rank": 2147483647,
- "similarweb_rank": 2147483647,
- "similarweb_traffic": 9223372036854776000,
- "website_technologies": [
- {
- "web_technology_id": 0,
- "is_active": true,
- "name": "string"
}
]
}
CreditsBalanceChangeLog list view.
account_id required | integer |
date_created_end | string <date-time> |
date_created_start | string <date-time> |
page | integer A page number within the paginated result set. |
{- "count": 15,
- "next": 2,
- "previous": null,
- "results": [
- {
- "id": 0,
- "change_type": "string",
- "change_sum": -2147483648,
- "change_description": "string",
- "date_created": "2019-08-24T14:15:22Z"
}
]
}
Calculate the total of credits spent during the specified timeframe.
account_id required | integer |
date_created_end | string <date-time> |
date_created_start | string <date-time> |
{- "total_credits_spent": 0
}
Handle creation of a new API key.
name | string <= 50 characters A free-form name for the API key. Need not be unique. 50 characters max. |
{- "name": "string"
}
{- "prefix": "string",
- "created": "2019-08-24T14:15:22Z",
- "name": "string"
}
{- "id": 0,
- "username": "string",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "accounts": [
- {
- "id": 0,
- "name": "string",
- "subscription": {
- "id": 0,
- "is_active": true,
- "credits_balance": 0,
- "subscription_tier": {
- "id": 0,
- "name": "string",
- "person_details_lookup": 2147483647,
- "person_work_email_lookup": 2147483647,
- "person_personal_email_lookup": 2147483647,
- "person_phone_number_lookup": 2147483647,
- "person_reverse_email_search": 2147483647,
- "person_reverse_phone_number_search": 2147483647,
- "person_role_details_lookup": 2147483647,
- "person_role_search_api_call": 2147483647,
- "job_search_api_call": 2147483647,
- "organization_search_api_call": 2147483647,
- "organization_technologies_lookup": 2147483647
}
}
}
]
}