Search jobs boards - Autotouch AI

This page documents the canonical HTTP contract for this endpoint.

The selected board may not honor every optional filter. The response metadata identifies the board and any continuation facts returned by the provider; do not assume a next page exists unless metadata supplies a token.

The current operation definition reports one credit per jobs-board search; read the returned pricing_rule and credits_used for the executed request.

The common response envelope contains items, total_found, billable_results, credits_used, pricing_rule, and metadata. Result item fields depend on this search family.

Body parameters

board · optional
string
indeed, google, or linkedin. Default: indeed.
queryrequired
string
Required non-blank role query.
location · optional
string
Optional free-text location.
country · optional
string
Provider country value (expected two-letter code); default US. The transport trims/lowercases it but does not validate its length.
language · optional
string
Provider interface-language value (expected two-letter code); default en. The transport trims/lowercases it but does not validate its length.
limit · optional
integer
Default 10; range 1–25.
date_posted · optional
string
any, today, 3days, week, or month. Default: any.
job_type · optional
string
Optional board-native job type.
sort · optional
string
relevance or date. Default: relevance.
page_token · optional
string
Opaque continuation token when returned by the board adapter.

Name	Type	Description
board	string	indeed, google, or linkedin. Default: indeed.
queryrequired	string	Required non-blank role query.
location	string	Optional free-text location.
country	string	Provider country value (expected two-letter code); default US. The transport trims/lowercases it but does not validate its length.
language	string	Provider interface-language value (expected two-letter code); default en. The transport trims/lowercases it but does not validate its length.
limit	integer	Default 10; range 1–25.
date_posted	string	any, today, 3days, week, or month. Default: any.
job_type	string	Optional board-native job type.
sort	string	relevance or date. Default: relevance.
page_token	string	Opaque continuation token when returned by the board adapter.

Errors

Status	Meaning
400	The search command or provider rejected the request.
401	Authentication is required.
402	Insufficient credits for this search.
403	Developer API key lacks required scope: search:run.
422	A request field is missing, outside its allowed range, or fails the typed request contract.

Example

bash

curl -X POST "https://app.autotouch.ai/api/search/board-jobs" -H "Authorization: Bearer $AUTOTOUCH_API_KEY" -H "Content-Type: application/json" -d '{"board":"indeed","query":"Account Executive","location":"New York, NY","country":"US","language":"en","limit":10,"date_posted":"week","sort":"date"}'

Request body

json

{
  "board": "indeed",
  "query": "Account Executive",
  "location": "New York, NY",
  "country": "US",
  "language": "en",
  "limit": 10,
  "date_posted": "week",
  "sort": "date"
}

Response example

json

{
  "items": [],
  "total_found": 0,
  "billable_results": 0,
  "credits_used": 0,
  "pricing_rule": "<effective rule for this search>",
  "metadata": {}
}