When you call Custom Field Service with GET method, you can find custom_field on next4biz CRM.
Your request body must be contain 4 properties.
tenant_slug This is your subdomain on selphiu URL. For example: if your selphiu domain is “acme.selpihu.com” then your tenant_slug is “acme”access_token next4biz CRM provide an access_token via access_token service. Every access_token expires after 15 minutes. Best Practice, you request a new access_token for each service request.channel This is bussines channel id. If you don’t know your bussiness_channels and there’s id numbers. You can learn via bussiness_channel service.custom_field This is an array includes objects as custom_field property is an object contain your custom_field search values. Every custom_field object property join as AND operator and every custom_field object JOIN as OR operator.You can sent two optional parameters:
limit Number of objects to return. Default is 50 maximum value is 200offset The number from which to start for read. Default is 0| Name | Value |
|---|---|
| REST-API METHOD | Read Custom Field |
| HTTP METHOD | GET |
| RESPONSE TYPE | JSON |
| URL | https://api.crm.next4biz.com/custom-field/ |
| REQUEST HEAD | Accept: application/json; Content-Type: application/json |
{
"tenant_slug": "acme",
"channel": "79",
"access_token": "[YOUR ACCESSTOKEN]",
"custom_field": [
{
"is_active": true,
"kind_id": 2
}
]
}{
"code": "200",
"status": "Success",
"result": [
{
"custom_field_id": "224",
"custom_field_type": {
"custom_field_type_id": 3,
"custom_field_type_name": "datetime"
},
"kind_id": 2,
"data": [],
"label": "date time type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 13,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
},
{
"custom_field_id": "223",
"custom_field_type": {
"custom_field_type_id": 3,
"custom_field_type_name": "datetime"
},
"kind_id": 2,
"data": [],
"label": "date time type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 12,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
},
{
"custom_field_id": "222",
"custom_field_type": {
"custom_field_type_id": 2,
"custom_field_type_name": "date"
},
"kind_id": 2,
"data": [],
"label": "date type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 11,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
},
{
"custom_field_id": "227",
"custom_field_type": {
"custom_field_type_id": 6,
"custom_field_type_name": "list"
},
"kind_id": 2,
"data": {
"index": 6,
"items": [
{
"id": 1,
"text": "List Choice - 1"
},
{
"id": 2,
"text": "List Choice - 2"
},
{
"id": 3,
"text": "List Choice - 3"
},
{
"id": 4,
"text": "List Choice - 4"
},
{
"id": 5,
"text": "List Choice - 5"
}
]
},
"label": "list type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 16,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
},
{
"custom_field_id": "226",
"custom_field_type": {
"custom_field_type_id": 5,
"custom_field_type_name": "multiple list"
},
"kind_id": 2,
"data": {
"index": 6,
"items": [
{
"id": 1,
"text": "Multi Choice - 1"
},
{
"id": 2,
"text": "Multi Choice - 2"
},
{
"id": 3,
"text": "Multi Choice - 3"
},
{
"id": 4,
"text": "Multi Choice - 4"
},
{
"id": 5,
"text": "Multi Choice - 5"
}
]
},
"label": "multiple list type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 15,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
},
{
"custom_field_id": "225",
"custom_field_type": {
"custom_field_type_id": 4,
"custom_field_type_name": "number"
},
"kind_id": 2,
"data": [],
"label": "number type custom field example",
"filterable": true,
"is_active": true,
"is_required": false,
"order_number": 14,
"created_at": "2017-09-05 15:21",
"tenant": {
"tenant_id": 74,
"tenant_name": "acme",
"tenant_slug": "acme",
"created_at": "2017-09-05 11:53:41"
}
}
]
}