Skip to main content
GET
Locations
Autocomplete cities, states, and countries. Each result includes a display label and a structured value for use in a job search.

Authentication and credits

Use Authorization: Bearer YOUR_API_KEY. An active API key is required. This endpoint consumes no credits and works with zero or negative balances.

Query parameters

string
required
Search text with at least three non-whitespace characters. The full query may contain at most 200 characters. Leading and trailing whitespace is ignored.
integer
default:"10"
Maximum suggestions to return, from 1 to 30.

Example request

Response

Pass selected value objects unchanged in jobs_locations or exclude_jobs_locations. state and city may be null for broader locations. Suggestions preserve relevance order and omit duplicates. No matches return an empty locations array.

Errors

Errors use a detail field. Successful responses use the object shown above, without a success or data wrapper.