Skip to main content
GET
/
custom-field-rules
/
List custom field rules
curl --request GET \
  --url https://api.journeybee.io/v1/custom-field-rules/ \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.journeybee.io/v1/custom-field-rules/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.journeybee.io/v1/custom-field-rules/', 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.journeybee.io/v1/custom-field-rules/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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.journeybee.io/v1/custom-field-rules/"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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.journeybee.io/v1/custom-field-rules/")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.journeybee.io/v1/custom-field-rules/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "uuid": "<string>",
    "label": "<string>",
    "active": true,
    "source_custom_field_uuid": "<string>",
    "source_values": [
      "<string>"
    ],
    "target_custom_field_uuid": "<string>",
    "target_value": {
      "text": "<string>",
      "number": 123,
      "date": "<string>",
      "boolean": true,
      "select": 123,
      "multi_select": [
        123
      ]
    },
    "value_mappings": [
      {
        "sourceValue": "<string>",
        "targetValue": {
          "text": "<string>",
          "number": 123,
          "date": "<string>",
          "boolean": true,
          "select": 123,
          "multi_select": [
            123
          ]
        }
      }
    ],
    "locked": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
active
boolean
required
source_custom_field_uuid
string
required
source_values
(string | number | boolean)[]
required
action_type
enum<string>
required
Available options:
set_value,
show_field,
value_mapping
target_custom_field_uuid
string
required
target_value
object · null · null
required

Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs).

value_mappings
object[] | null
required
locked
boolean
required
entity_type
enum<string>
required
Available options:
partner,
lead,
lead_deal,
contact
created_at
string
required
updated_at
string
required