curl --request GET \
--url https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage} \
--header 'Authorization: Bearer <token>'{
"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
}
}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.
curl --request GET \
--url https://api.joinworth.com/case/api/v1/businesses/{businessID}/custom-fields{?pagination}{?page}{?itemsPerPage} \
--header 'Authorization: Bearer <token>'{
"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
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
"f17295d4-5237-4079-8b18-8786eddf49f3"
Boolean indicating whether results should be paginated or not.
true
false
Integer value of which page to retrieve.
x >= 11
2
3
Integer value for how many results should be included per page.
x >= 11
5
10
20
25
50
999
Was this page helpful?