POST /v1/business/{businessNumber}/search
Servers
- https://api.birdeye.com/resources
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
businessNumber |
Number | Yes |
Long id of the business, under which user wants to search for. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
api_key |
String | No |
e.g. [Required] Partner specific API key provided by Birdeye for data exchange. |
Accept |
String | No |
e.g. application/json |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sortOrder |
String | No |
The SORT order, Possible values "ASC" or "DESC". By default is "DESC". |
searchStr |
String | No |
Search criteria for business. This could be business name or number. |
sortBy |
String | No |
Results can be sorted by name, createdAt, and createdBy. By default is createdAt. name : The business name createdAt: The date on which a business/location was created. createdBy: The full name of the user that created the business. |
startIndex |
Number | No |
Once sorted, it defines starting from which index a page (number of specified search results) is to be created. |
pageSize |
Number | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.