Skip to content
/
Job post event search

Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Job Posts

Operations

Job post event search

Request

Job post event search.

Security
Api-Key
Path
account_idintegerrequired
Body
pageinteger
job_sourcestring(JobSourceEnum)
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
Enum"indeed""linkedin""angellist"
date_featured_startstring(date)
date_featured_endstring(date)
organization_idsArray of integers

To get a list of IDs use Organizations lookup endpoint.

titlestring

This field supports a boolean text search query.

descriptionstring

This field supports a boolean text search query.

is_remoteboolean or null
is_activeboolean
Default true
locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

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

Responses

Bodyapplication/json
search_resultsArray of objects(JobPostEventSearchResult)read-onlyrequired
search_results[].​idintegerread-onlyrequired
search_results[].​sourcestringread-onlyrequired
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
Enum"indeed""linkedin""angellist"
search_results[].​date_featuredstring(date)required
search_results[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

search_results[].​organization.​idintegerread-onlyrequired
search_results[].​organization.​namestring<= 255 charactersrequired
search_results[].​organization.​domainstring or null(uri)<= 200 characters
search_results[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

search_results[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
search_results[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

search_results[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
search_results[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
search_results[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

search_results[].​source_idstring<= 65 charactersrequired
search_results[].​urlstring(uri)<= 510 charactersrequired
search_results[].​titlestring<= 255 charactersrequired
search_results[].​descriptionstring or null
search_results[].​is_remoteboolean(Is remote?)required
search_results[].​locationobjectread-onlyrequired

Serializer for the InnerLocation model for Jobs search API.

search_results[].​location.​idintegerread-onlyrequired
search_results[].​location.​namestring<= 255 charactersrequired
search_results[].​location.​osm_locationsArray of objects(JobOSMLocation)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[].​is_activeboolean(Is active?)required
total_search_resultsinteger>= 0required
Response
application/json
{
  "search_results": [
    { … }
  ],
  "total_search_results": 0
}

Job post event search totals

Request

Job post event search totals.

Security
Api-Key
Path
account_idintegerrequired
Body
pageinteger
job_sourcestring(JobSourceEnum)
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
Enum"indeed""linkedin""angellist"
date_featured_startstring(date)
date_featured_endstring(date)
organization_idsArray of integers

To get a list of IDs use Organizations lookup endpoint.

titlestring

This field supports a boolean text search query.

descriptionstring

This field supports a boolean text search query.

is_remoteboolean or null
is_activeboolean
Default true
locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

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

Responses

Bodyapplication/json
total_search_resultsinteger>= 0required
Response
application/json
{
  "total_search_results": 0
}

Organizations

Operations

People

Operations

Websites

Operations

Users

Operations

Autocomplete

Operations