β‘ Quickstart
This guide walks through how to make your first Job Posting Search API request from start to finish. π You can copy the examples below and run them as-is after adding your API key.ποΈ Before You Start
1
Make sure you have access
The Job Posting Search API is currently in beta.To use it, you need:
- An active PDL API key
- Beta access enabled for the Job Posting Search API on that key
2
Know what this endpoint does
The Job Posting Search API lets you search the full PDL Job Posting Dataset and return complete job posting records.Endpoint:
https://api.peopledatalabs.com/v5/job_posting/searchThere are two ways to search:- Field Filters (parameterized input fields)
- An Elasticsearch query
π Your First Request
To start off, letβs try a simple search:Give me a few engineering-related job postings at OpenAI.We will use these filters:
company_website: limits results to a companytitle_role: limits results to a PDL role categorysize: controls how many records come back
Example
Donβt forget your API Key!For the example above, you will have to replace
YOUR_API_KEY with your actual API Key.Why This Query Works
The request above uses the simple filter approach:company_website: "openai.com"tells PDL which company to search fortitle_role: "engineering"filters to job postings classified into theengineeringrolesize: 3keeps the response small and easy to inspect
Credits and record countsEach returned job posting record consumes 1 credit. If
size is 3 and the API returns 3 records, that request uses 3 credits.Example Response
Your response will look something like this:JSON
How To Read The Response
Here are the key fields to notice:data: the list of job posting records returned for this requesttotal: the total number of matching records in the dataset, not just the number returned in this responsescroll_token: a token you can use to fetch the next batch of results if you want more records
data is a full job posting record, including fields such as title, company, location, description, salary information when available, and lifecycle dates like first_seen, last_verified, and deactivated_date.
Full Field ListYou can see the full list of fields returned for each Job Posting record here: Job Posting Data Overview. For a field-by-field breakdown of the API response, see Output Response.
π« Common Mistakes
If you get a401 Unauthorized response, check that:
- your API key is included in the request
- your API key is correct
- your API key has beta access to the Job Posting Search API enabled
What To Do Next
Once you are ready to go further, these are the most useful next pages:- Use Cases for examples of real-world use cases for the Job Posting Search API
- Examples for more query patterns, pagination examples, and advanced Elasticsearch examples
- Reference for endpoint behavior, billing, and request rules
- Input Parameters for detailed field-by-field behavior
- Output Response for response structure details
- FAQs for additional tips and answers to common questions
size, inspect real results, and then add filters or move into the Examples page as your query gets more specific.