For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a Schedule

Save a job search that re-runs on a schedule into a list.

POST /jobs_schedule_create

Saves a LinkedIn job search that runs again on a schedule. Each run saves the new jobs into listname. With find_contact on, each run also finds people with the given titles at the hiring companies and adds them, with their emails, to the same list.

Saving is free. Each run is billed like any Job Search: 0.1 credit per new job saved. Jobs already on the list are skipped and not charged (unique_jobs, on by default). With find_contact on, the people and emails found are billed at their normal rates.

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

api_key

string

Required. Your API key.

listname

string

Required. The list every run saves into.

keywords

string

Required. LinkedIn job keywords, e.g. roofing estimator.

job_location

string

Required. A LinkedIn location name: United States, Texas, United States, Toronto, Ontario, Canada.

schedule_type

string

daily, weekly or every_x_days (default).

run_every_x_days

integer

With every_x_days. Default 7.

schedule_days

array

With weekly: weekday names, e.g. ["Monday", "Thursday"].

run_now

boolean

Also start the first run now. Default false.

time_posted

string

Any Time, Past 24 Hours, Past Week or Past Month. Leave it out and it matches the timing: daily searches the past 24 hours, weekly the past week, every_x_days the past 24 hours, week or month, whichever covers the gap.

job_types

array

Any of Full-time, Part-time, Contract, Temporary, Volunteer, Internship.

experience_levels

array

Any of Internship, Entry level, Associate, Mid-Senior level, Director, Executive.

salary_min

string

Any, $40,000+ ... $200,000+.

max_results

integer

Most jobs per run, 10 to 5000. Default 100.

unique_jobs

boolean

Skip jobs already on the list. Default true.

exclude_staffing_company

boolean

Drop jobs posted by staffing and recruiting firms.

find_contact

boolean

After each run, find people at the hiring companies. Needs titles.

titles

array

Job titles to find, e.g. ["Owner", "CEO"].

company_size

array

Only hiring companies of these sizes: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+.

contact_location

array

Only people in these places, e.g. ["united states"].

max_contacts

integer

Most people to find per run.

find_job_posters

boolean

Also find the person who posted each job.

is_active

boolean

Send false to save it paused.

Response

Field
Description

data.schedule

The saved schedule, same fields as List Schedules.

data.run_started

true when run_now started the first run.

credits_estimated

With run_now: the most the jobs part of the run can cost (0.1 x max_results).

credits_used

Always 0. The run itself is billed as it happens.

Example

This weekly schedule sends no time_posted, so it is saved as Past Week.

See what the run found with Schedule Run History.