Skip to main content
POST
/yell/businesses/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
location
string
default:""
sort
enum<string>
default:relevance
Available options:
relevance,
rating,
most_reviewed
distance
enum<string>
default:any
Available options:
any,
2,
5,
10

Response

Successful Response

@type
string
default:YellBusinessSearchResult
id
string | null
name
string | null
rating
number | null
review_count
integer | null
category
string | null
phone
string | null
website
string | null
image
string | null
is_sponsored
boolean
default:false
profile_url
string | null