Get
curl --request GET \
--url 'https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}', 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/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 376,
"fieldValue": "Green",
"fieldName": "colours",
"type": "DROPDOWN_MULTI",
"defaultValue": "Green",
"fieldDescription": "This custom field contains list of colours",
"filterable": true
}{
"code": 5025,
"message": "Custom field not found."
}Custom Fields
Get Custom Field
GET
/
v1
/
business
/
public
/
custom-fields
/
get
/
{fieldId}
?locationBizNumber=
{locationBizNumber}
Get
curl --request GET \
--url 'https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}', 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/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 376,
"fieldValue": "Green",
"fieldName": "colours",
"type": "DROPDOWN_MULTI",
"defaultValue": "Green",
"fieldDescription": "This custom field contains list of colours",
"filterable": true
}{
"code": 5025,
"message": "Custom field not found."
}Headers
e.g. application/json
e.g. - Partner specific API key provided by Birdeye for data exchange.
e.g. - Long Business Number
Path Parameters
fieldId of the custom field created earlier.
Long Location number of the Location
Response
OK
fieldId of the custom field.
Example:
376
Field Value of custom field and will only be visible if value is present.
Example:
"Green"
Name of the custom field.
Example:
"colours"
Type of field.
Example:
"DROPDOWN_MULTI"
Default Value of custom field and will only be visible if value is present.
Example:
"Green"
Description of custom field.
Example:
"This custom field contains list of colours"
Whether the custom field will be filterable or not.