v1

latestOpenAPI 3.1.02026-07-248941352.6 KB

Home Services

Get Jobs

This endpoint identifies the most relevant job types based on the end user's home service needs. By providing details about what the user is looking for, this endpoint returns multiple matching job types. From these, a single job type is selected and used as input for the Get Survey endpoint to continue the matching flow.

post/v3/jobs

Request body

querystring required

Natural language text describing the needs.

localestring yelp-supported-locale

Locale code in the format of {language code}_{country code}. See the list of supported locales.

Example request

{
  "query": "Bathroom sink leaking water under cabinet while running",
  "locale": "en_US"
}

Response

Successfully retrieved jobs

Example response

{
  "jobs": [
    {
      "job_alias": "job_faucet_repair",
      "display_name": "Faucet Repair",
      "description": "Repair or replacement of sink, bathtub, or shower faucets"
    }
  ]
}