Get Business Custom Fields
curl --request GET \
--url https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}', 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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}",
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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}"
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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}")
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{
"status": "success",
"message": "Detailed custom fields fetched successfully.",
"data": {
"records": [
{
"label": "Type of Equipment",
"field_id": "type_of_equipment",
"step_name": "Payment Equipment",
"sequence_number": 1,
"value": [
{
"label": "Terminal",
"value": "Terminal",
"checkbox_type": "",
"checked": true
},
{
"label": "Pin Pad",
"value": "Pin Pad",
"checkbox_type": "",
"checked": false
}
],
"data_type": "Checkbox",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"type_of_equipment"
],
"properties": {
"type_of_equipment": {}
}
}
},
{
"label": "Manufacturer",
"field_id": "manufacturer",
"step_name": "Payment Equipment",
"sequence_number": 2,
"value": "Computron Payment Hardware Corp",
"data_type": "Text",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"manufacturer"
],
"properties": {
"manufacturer": {}
}
}
},
{
"label": "Model Version",
"field_id": "model_version",
"step_name": "Payment Equipment",
"sequence_number": 3,
"value": "4.0.1",
"data_type": "Text",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"model_version"
],
"properties": {
"model_version": {}
}
}
},
{
"label": "Quantity",
"field_id": "quantity",
"step_name": "Payment Equipment",
"sequence_number": 4,
"value": 6,
"data_type": "Integer",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"quantity"
],
"properties": {
"quantity": {}
}
}
},
{
"label": "Deployment",
"field_id": "deployment",
"step_name": "Payment Equipment",
"sequence_number": 5,
"value": [
{
"label": "New Order",
"value": "New Order",
"checkbox_type": "",
"checked": true
}
],
"data_type": "Checkbox",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"properties": {
"deployment": {}
}
}
}
],
"total_pages": 1,
"total_items": 5
}
}Custom Fields
Get Business Custom Fields
Retrieves custom fields associated with a specified business ID. Custom fields must be enabled to utilize this endpoint. To confirm if you have custom fields enabled, please reach out to your Customer Success representative.
GET
/
businesses
/
{businessID}
/
custom-fields
{?pagination}
{?page}
{?itemsPerPage}
Get Business Custom Fields
curl --request GET \
--url https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}', 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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}",
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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}"
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.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage}")
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{
"status": "success",
"message": "Detailed custom fields fetched successfully.",
"data": {
"records": [
{
"label": "Type of Equipment",
"field_id": "type_of_equipment",
"step_name": "Payment Equipment",
"sequence_number": 1,
"value": [
{
"label": "Terminal",
"value": "Terminal",
"checkbox_type": "",
"checked": true
},
{
"label": "Pin Pad",
"value": "Pin Pad",
"checkbox_type": "",
"checked": false
}
],
"data_type": "Checkbox",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"type_of_equipment"
],
"properties": {
"type_of_equipment": {}
}
}
},
{
"label": "Manufacturer",
"field_id": "manufacturer",
"step_name": "Payment Equipment",
"sequence_number": 2,
"value": "Computron Payment Hardware Corp",
"data_type": "Text",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"manufacturer"
],
"properties": {
"manufacturer": {}
}
}
},
{
"label": "Model Version",
"field_id": "model_version",
"step_name": "Payment Equipment",
"sequence_number": 3,
"value": "4.0.1",
"data_type": "Text",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"model_version"
],
"properties": {
"model_version": {}
}
}
},
{
"label": "Quantity",
"field_id": "quantity",
"step_name": "Payment Equipment",
"sequence_number": 4,
"value": 6,
"data_type": "Integer",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"required": [
"quantity"
],
"properties": {
"quantity": {}
}
}
},
{
"label": "Deployment",
"field_id": "deployment",
"step_name": "Payment Equipment",
"sequence_number": 5,
"value": [
{
"label": "New Order",
"value": "New Order",
"checkbox_type": "",
"checked": true
}
],
"data_type": "Checkbox",
"applicant_access": "HIDDEN",
"customer_access": "DEFAULT",
"is_sensitive": false,
"rules": {
"type": "object",
"properties": {
"deployment": {}
}
}
}
],
"total_pages": 1,
"total_items": 5
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Example:
"f17295d4-5237-4079-8b18-8786eddf49f3"
Query Parameters
Boolean indicating whether results should be paginated or not.
Examples:
true
false
Integer value of which page to retrieve.
Required range:
x >= 1Examples:
1
2
3
Integer value for how many results should be included per page.
Required range:
x >= 1Examples:
1
5
10
20
25
50
999
Was this page helpful?
⌘I