curl --request GET \
--url https://api.bigco.ai/api/v1/custom_data \
--header 'x-bigco-hmac-sha256: <api-key>'import requests
url = "https://api.bigco.ai/api/v1/custom_data"
headers = {"x-bigco-hmac-sha256": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-bigco-hmac-sha256': '<api-key>'}};
fetch('https://api.bigco.ai/api/v1/custom_data', 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.bigco.ai/api/v1/custom_data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-bigco-hmac-sha256: <api-key>"
],
]);
$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.bigco.ai/api/v1/custom_data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-bigco-hmac-sha256", "<api-key>")
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.bigco.ai/api/v1/custom_data")
.header("x-bigco-hmac-sha256", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigco.ai/api/v1/custom_data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-bigco-hmac-sha256"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"field_name": "loyalty_tier",
"custom_data_type": 3,
"id": 42,
"description": "The customer's loyalty program tier.",
"subtype": 3,
"available_enum_values": [
"Bronze",
"Silver",
"Gold"
],
"include_in_ai_prompt": false,
"include_user_answers": false,
"is_append": false,
"is_auto_collected": false,
"extraction_prompt": "<string>",
"is_emphasize_current": true,
"is_emphasize_personal": true
}
]{
"detail": {
"type": "not_authenticated",
"msg": "HMAC signature verification failed"
}
}{
"detail": {
"type": "UNCAUGHT_ERROR",
"msg": "Internal server error"
}
}List custom data fields
Returns all custom data fields configured for your brand. Use the field_name values to populate custom_data on user create/update and the custom_ columns in CSV imports.
curl --request GET \
--url https://api.bigco.ai/api/v1/custom_data \
--header 'x-bigco-hmac-sha256: <api-key>'import requests
url = "https://api.bigco.ai/api/v1/custom_data"
headers = {"x-bigco-hmac-sha256": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-bigco-hmac-sha256': '<api-key>'}};
fetch('https://api.bigco.ai/api/v1/custom_data', 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.bigco.ai/api/v1/custom_data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-bigco-hmac-sha256: <api-key>"
],
]);
$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.bigco.ai/api/v1/custom_data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-bigco-hmac-sha256", "<api-key>")
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.bigco.ai/api/v1/custom_data")
.header("x-bigco-hmac-sha256", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigco.ai/api/v1/custom_data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-bigco-hmac-sha256"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"field_name": "loyalty_tier",
"custom_data_type": 3,
"id": 42,
"description": "The customer's loyalty program tier.",
"subtype": 3,
"available_enum_values": [
"Bronze",
"Silver",
"Gold"
],
"include_in_ai_prompt": false,
"include_user_answers": false,
"is_append": false,
"is_auto_collected": false,
"extraction_prompt": "<string>",
"is_emphasize_current": true,
"is_emphasize_personal": true
}
]{
"detail": {
"type": "not_authenticated",
"msg": "HMAC signature verification failed"
}
}{
"detail": {
"type": "UNCAUGHT_ERROR",
"msg": "Internal server error"
}
}Authorizations
Base64-encoded HMAC-SHA256 signature of the request. Every request must also include the x-bigco-hmac-username and x-date headers, and POST/PUT requests must include x-digest. See the Authentication guide for the full signing procedure.
Response
Your brand's custom data fields.
The custom data field name. Lowercase and snake-case it (and prefix with custom_ for CSV imports) when supplying values.
"loyalty_tier"
The data type of the field: 1 = INTEGER, 2 = FLOAT, 3 = STRING, 4 = LIST, 5 = BOOLEAN, 6 = DATE.
1, 2, 3, 4, 5, 6 3
42
"The customer's loyalty program tier."
For LIST fields, the type code of the list elements.
3
If set, only these values are accepted for the field.
["Bronze", "Silver", "Gold"]