Skip to main content
POST
Search Business

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Content-Type
string
default:application/json

Media type of the JSON request body.

Path Parameters

businessNumber
number
required

Long id of the business, under which user wants to search for.

Body

application/json
searchStr
string

Search criteria for business. This could be business name or number.

sortBy
string

Results can be sorted by name, createdAt, and createdBy. By default is createdAt.

sortOrder
string

The SORT order, Possible values "ASC" or "DESC". By default is "DESC".

startIndex
number

Once sorted, it defines starting from which index a page (number of specified search results) is to be created.

pageSize
number

Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25.

Response

OK

totalCount
number

The total number of search matches.

accounts
object[]

Search results