Account ID
Account ID
The ID of your Forager account. It goes in the path of most API requests as
{account_id}. Find it on the My Account page of the Forager Web App.API key
API key
The secret you send in the
X-API-KEY header to authenticate API requests. Create one in the Forager Web App. Credits are charged to the account the key belongs to. See Authentication.Credits
Credits
The unit Forager charges for API requests. Each request type uses a set number of credits. See Credit pricing.
Forager ID
Forager ID
The numeric ID of a person record in the Forager dataset. Request bodies use it as
person_id. Person role search returns it as person.id on each result; the top-level id of a result is the role, not the person. See Recipes.LinkedIn public identifier
LinkedIn public identifier
The slug in a LinkedIn profile URL (
linkedin.com/in/<slug>/). Several endpoints accept it as linkedin_public_identifier to identify a person. For organizations it is the slug in linkedin.com/company/<slug>/.Autocomplete
Autocomplete
Endpoints that turn free text (industries, organizations, organization keywords, locations, person skills, web technologies) into the IDs that the search endpoints accept as filters. See Autocomplete.
Role search
Role search
A search for people by role: title, description, current or past role, dates, person and organization attributes. See Person role search.
Totals endpoint
Totals endpoint
A search variant that returns match counts for a query instead of the full result set. For example, Person role search totals.
Work email lookup job
Work email lookup job
An asynchronous work email lookup. Submitting returns a
job_id and a status_check_url; you poll until status is completed or failed. A bulk submission returns a batch_id instead. See Work Emails.Webhook URL
Webhook URL
An optional https URL on work email lookups. Forager POSTs the results there when the job or batch completes, so you do not need to poll.
Data feed
Data feed
Bulk people, company and job datasets delivered as files under an annual license, as opposed to API requests. See Data Feed V2 Overview.
serialized_data
serialized_data
The property of each data feed record that holds the JSON object described by the schema.