Search Business
curl --request POST \
--url https://api.birdeye.com/resources/v1/business/{businessNumber}/search \
--header 'Content-Type: application/json' \
--data '
{
"pageSize": 25,
"searchStr": "Thurston Rosenlund",
"sortBy": "createdAt",
"sortOrder": "ASC",
"startIndex": 0
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/{businessNumber}/search"
payload = {
"pageSize": 25,
"searchStr": "Thurston Rosenlund",
"sortBy": "createdAt",
"sortOrder": "ASC",
"startIndex": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageSize: 25,
searchStr: 'Thurston Rosenlund',
sortBy: 'createdAt',
sortOrder: 'ASC',
startIndex: 0
})
};
fetch('https://api.birdeye.com/resources/v1/business/{businessNumber}/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/business/{businessNumber}/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageSize' => 25,
'searchStr' => 'Thurston Rosenlund',
'sortBy' => 'createdAt',
'sortOrder' => 'ASC',
'startIndex' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/{businessNumber}/search"
payload := strings.NewReader("{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/business/{businessNumber}/search")
.header("Content-Type", "application/json")
.body("{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/{businessNumber}/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}"
response = http.request(request)
puts response.read_body{
"accounts": [
{
"name": "Thurston Rosenlund",
"status": "suspended",
"createdAt": "May 01, 2013",
"createdBy": "Sam Bilings",
"businessNumber": 396982176121,
"type": "Business"
},
{
"name": "Aspen Springs Dental",
"status": "paid",
"createdAt": "May 20, 2013",
"businessNumber": 106026111239,
"type": "Business"
},
{
"name": "Cherry Creek Family Dental",
"status": "paid",
"createdAt": "May 20, 2013",
"businessNumber": 379451236128,
"type": "Business"
}
],
"totalCount": 44
}{
"code": 400,
"message": "Page size must not be less than one!"
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}Business
Search Business
POST
/
v1
/
business
/
{businessNumber}
/
search
Search Business
curl --request POST \
--url https://api.birdeye.com/resources/v1/business/{businessNumber}/search \
--header 'Content-Type: application/json' \
--data '
{
"pageSize": 25,
"searchStr": "Thurston Rosenlund",
"sortBy": "createdAt",
"sortOrder": "ASC",
"startIndex": 0
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/{businessNumber}/search"
payload = {
"pageSize": 25,
"searchStr": "Thurston Rosenlund",
"sortBy": "createdAt",
"sortOrder": "ASC",
"startIndex": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageSize: 25,
searchStr: 'Thurston Rosenlund',
sortBy: 'createdAt',
sortOrder: 'ASC',
startIndex: 0
})
};
fetch('https://api.birdeye.com/resources/v1/business/{businessNumber}/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/business/{businessNumber}/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageSize' => 25,
'searchStr' => 'Thurston Rosenlund',
'sortBy' => 'createdAt',
'sortOrder' => 'ASC',
'startIndex' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/{businessNumber}/search"
payload := strings.NewReader("{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/business/{businessNumber}/search")
.header("Content-Type", "application/json")
.body("{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/{businessNumber}/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageSize\": 25,\n \"searchStr\": \"Thurston Rosenlund\",\n \"sortBy\": \"createdAt\",\n \"sortOrder\": \"ASC\",\n \"startIndex\": 0\n}"
response = http.request(request)
puts response.read_body{
"accounts": [
{
"name": "Thurston Rosenlund",
"status": "suspended",
"createdAt": "May 01, 2013",
"createdBy": "Sam Bilings",
"businessNumber": 396982176121,
"type": "Business"
},
{
"name": "Aspen Springs Dental",
"status": "paid",
"createdAt": "May 20, 2013",
"businessNumber": 106026111239,
"type": "Business"
},
{
"name": "Cherry Creek Family Dental",
"status": "paid",
"createdAt": "May 20, 2013",
"businessNumber": 379451236128,
"type": "Business"
}
],
"totalCount": 44
}{
"code": 400,
"message": "Page size must not be less than one!"
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
Path Parameters
Long id of the business, under which user wants to search for.
Body
application/json
Search criteria for business. This could be business name or number.
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.
The SORT order, Possible values "ASC" or "DESC". By default is "DESC".
Once sorted, it defines starting from which index a page (number of specified search results) is to be created.
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.