Reference
The Job Posting Search API can be used to search and retrieve full job posting records from our complete Job Posting Dataset. The API offers two ways to query:- Using Field Filters
- Using an Elasticsearch query
Endpoint
The endpoint for the Job Posting Search API ishttps://api.peopledatalabs.com/v5/job_posting/search.
Access
The Job Posting Search API is currently in Beta, and is available to all customers. To request access, please reach out to your customer success team or contact us.Billing
The Job Posting Search API consumes 1 credit per record retrieved. Each job posting record in thedata array in the response counts as one credit against your credit limit.
For example, a query that returns 10 job posting records will consume 10 credits.
Controlling the Number of Credits Used Per API CallYou can use the
size parameter to limit the number of records returned in a query (and therefore control the number of credits consumed by your API calls).Authentication
See Authentication to learn how to authenticate input requests. We recommend using a JSON object to capture request parameters and will do so in the examples.Rate Limiting
The current default rate limit is 20 requests per minute.Input Parameters
Required: Search Mode
The Job Posting Search API requires exactly one of the following:Field Filters
See Field Filter Examples for working examples of these built-in filters.
- Each filter maps to predefined search behavior on a specific field (or fields).
- Multiple filters are combined using AND logic
- Each field has fixed matching and input standardization behavior
Example:company_website=peopledatalabs.comANDtitle=data engineer
Behavior Legend
- Exact = exact match
- Phrase = case-insensitive, supports substring match
- Match = case-insensitive, allows partial string matching
- Cleaned = input is normalized via PDL cleaners before matching
- Canonical = must match a predefined set of values
- Range
≥/≤= numeric comparison against stored values - Boolean = filters based on true / false behavior
Elasticsearch Query
See Elasticsearch Query Examples for working examples of these queries.
query to send a raw Elasticsearch(v7.7) query to the Job Posting Search API:
- Supports ES queries like
bool,term,terms,match,range,exists(full list) - Overrides all Field Filters if both are provided
- Limited to only fields that are mapped in the Elasticsearch Index
Optional Input Fields
These are additional input parameters you can provide to the Job Posting Search API.Output Response
The Job Posting Search API returns an HTTP response code of200 for any valid request with at least one matching result. Each record in the response counts as a single credit against your total credit limit.
Response Fields
Response Data Structure
The response from the Job Posting Search API will be in this format:JSON
data object.
Errors
If your request encounters an error, it will return an Error Response. No credits are consumed for API calls that return an error or non-200 status code.
For additional details, see our page on Errors & Status Codes.
