Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://api-v2.forager.ai/

datastorage

Operations

organizations

Operations

Organization search

Request

Organization search.

Path

account_idintegerrequired

Body

pageinteger

organization_idsArray of integers

To get a list of IDs use Organizations lookup endpoint.

descriptionstring

locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

keywordsArray of integers

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

employees_startinteger

employees_endinteger

founded_date_startstring(date)

founded_date_endstring(date)

revenue_startinteger

revenue_endinteger

domainsArray of strings

domain_rank_startinteger

domain_rank_endinteger

domain_traffic_startinteger

domain_traffic_endinteger

web_technologiesArray of integers

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

linkedin_public_identifiersArray of strings

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

funding_typesArray 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"

funding_total_startinteger

funding_total_endinteger

funding_event_date_featured_startstring(date)

funding_event_date_featured_endstring(date)

job_post_titlestring

This field supports a boolean text search query.

job_post_descriptionstring

This field supports a boolean text search query.

job_post_is_remoteboolean or null

job_post_is_activeboolean or null

job_post_date_featured_startstring(date)

job_post_date_featured_endstring(date)

job_post_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_sourcestring(SimpleEventSourceEnum)

product_hunt - Product Hunt
form_c_sec_gov - Form C sec.gov
form_d_sec_gov - Form D sec.gov

Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"

simple_event_reasonstring(SimpleEventReasonEnum)

report_released - Report released
promoted_on_site - Promoted on site

Enum"report_released""promoted_on_site"

simple_event_date_featured_startstring(date)

simple_event_date_featured_endstring(date)

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/organization_search/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Bodyapplication/json

search_resultsArray of objects(OrganizationSearchResult)read-onlyrequired

search_results[].idintegerread-onlyrequired

search_results[].namestring<= 255 charactersrequired

search_results[].legal_namestring<= 255 charactersrequired

search_results[].websitestring or null(uri)<= 16384 characters

search_results[].domainstring or null(uri)<= 200 characters

search_results[].domain_rankinteger or nullread-onlyrequired

Domain rank.

search_results[].logostring or null(uri)<= 510 characters

search_results[].descriptionstring or null

search_results[].founded_datestring or null(date)

search_results[].operating_statusstring or null<= 255 characters

search_results[].employees_rangestring or null<= 255 characters

search_results[].employees_amountinteger or null[ 0 .. 2147483647 ]

search_results[].keywordsArray of objects(OrganizationKeyword)read-onlyrequired

search_results[].keywords[].idintegerread-onlyrequired

search_results[].keywords[].namestring<= 255 charactersrequired

search_results[].locationobjectread-onlyrequired

Serializer for the InnerLocation model.

search_results[].location.idintegerread-onlyrequired

search_results[].location.namestring<= 255 charactersrequired

search_results[].location.osm_locationsArray of objects(OSMLocation)read-onlyrequired

search_results[].location.osm_locations[].idintegerread-onlyrequired

search_results[].location.osm_locations[].namestring<= 255 charactersrequired

search_results[].location.osm_locations[].place_typestring(Type)<= 255 charactersrequired

search_results[].finance_infoobjectread-onlyrequired

Serializer for the OrganizationFinanceInfo model.

search_results[].finance_info.revenueinteger or null(int64)[ 0 .. 9223372036854776000 ]

search_results[].linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

search_results[].linkedin_info.public_identifierstring or null<= 255 characters

search_results[].linkedin_info.industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

search_results[].linkedin_info.industry.idintegerread-onlyrequired

search_results[].linkedin_info.industry.namestring<= 255 charactersrequired

search_results[].linkedin_info.public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

search_results[].addressesArray of objects(OrganizationAddress)read-onlyrequired

search_results[].addresses[].street_numberstring or null<= 255 characters

search_results[].addresses[].street_namestring or null<= 255 characters

search_results[].addresses[].citystring or null<= 255 characters

search_results[].addresses[].statestring or null(State/County)<= 255 characters

search_results[].addresses[].postcodestring or null(Post/Zip-code)<= 64 characters

search_results[].addresses[].countrystring<= 255 charactersrequired

search_results[].addresses[].summarystringrequired

search_results[].date_updatedstring(date-time)read-onlyrequired

search_results[].found_simple_eventsArray of objects(OrganizationSimpleEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].found_simple_events[].idintegerread-onlyrequired

search_results[].found_simple_events[].sourcestringread-onlyrequired

product_hunt - Product Hunt
form_c_sec_gov - Form C sec.gov
form_d_sec_gov - Form D sec.gov

Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"

search_results[].found_simple_events[].date_featuredstring(date)required

search_results[].found_simple_events[].organization_idintegerread-onlyrequired

search_results[].found_simple_events[].reasonstring(ReasonEnum)required

report_released - Report released
promoted_on_site - Promoted on site

Enum"report_released""promoted_on_site"

search_results[].found_simple_events[].urlstring(uri)<= 255 charactersrequired

search_results[].found_funding_eventsArray of objects(OrganizationFundingEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].found_funding_events[].idintegerread-onlyrequired

search_results[].found_funding_events[].sourcestringread-onlyrequired

crunchbase - Crunchbase

Value"crunchbase"

search_results[].found_funding_events[].date_featuredstring(date)required

search_results[].found_funding_events[].organization_idintegerread-onlyrequired

search_results[].found_funding_events[].funding_typestring<= 255 charactersrequired

search_results[].found_funding_events[].funding_totalinteger(int64)[ 0 .. 9223372036854776000 ]required

search_results[].found_job_post_eventsArray of objects(OrganizationJobPostEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].found_job_post_events[].idintegerread-onlyrequired

search_results[].found_job_post_events[].sourcestringread-onlyrequired

indeed - Indeed
linkedin - LinkedIn
angellist - AngelList

Enum"indeed""linkedin""angellist"

search_results[].found_job_post_events[].date_featuredstring(date)required

search_results[].found_job_post_events[].organization_idintegerread-onlyrequired

search_results[].found_job_post_events[].source_idstring<= 65 charactersrequired

search_results[].found_job_post_events[].urlstring(uri)<= 510 charactersrequired

search_results[].found_job_post_events[].titlestring<= 255 charactersrequired

search_results[].found_job_post_events[].is_remoteboolean(Is remote?)required

search_results[].found_job_post_events[].is_activeboolean(Is active?)required

total_search_resultsinteger>= 0required

Response

application/json

{
  "search_results": [
    { … }
  ],
  "total_search_results": 0
}

Organization search totals

Request

Organization search totals.

Path

account_idintegerrequired

Body

pageinteger

organization_idsArray of integers

To get a list of IDs use Organizations lookup endpoint.

descriptionstring

locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

keywordsArray of integers

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

employees_startinteger

employees_endinteger

founded_date_startstring(date)

founded_date_endstring(date)

revenue_startinteger

revenue_endinteger

domainsArray of strings

domain_rank_startinteger

domain_rank_endinteger

domain_traffic_startinteger

domain_traffic_endinteger

web_technologiesArray of integers

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

linkedin_public_identifiersArray of strings

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

funding_typesArray 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"

funding_total_startinteger

funding_total_endinteger

funding_event_date_featured_startstring(date)

funding_event_date_featured_endstring(date)

job_post_titlestring

This field supports a boolean text search query.

job_post_descriptionstring

This field supports a boolean text search query.

job_post_is_remoteboolean or null

job_post_is_activeboolean or null

job_post_date_featured_startstring(date)

job_post_date_featured_endstring(date)

job_post_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_sourcestring(SimpleEventSourceEnum)

product_hunt - Product Hunt
form_c_sec_gov - Form C sec.gov
form_d_sec_gov - Form D sec.gov

Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"

simple_event_reasonstring(SimpleEventReasonEnum)

report_released - Report released
promoted_on_site - Promoted on site

Enum"report_released""promoted_on_site"

simple_event_date_featured_startstring(date)

simple_event_date_featured_endstring(date)

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/organization_search/totals/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Bodyapplication/json

total_search_resultsinteger>= 0required

Response

application/json

{
  "total_search_results": 0
}

persons

Operations

subscriptions

Operations

api_keys

Operations

users

Operations

objects-lookups

Operations

Forager public API (1.0.0)

datastorage

organizations

Organization search

Request

Responses

Was this helpful?

Organization search totals

Request

Responses

Was this helpful?

persons

subscriptions

api_keys

users

objects-lookups