Get Custom Field definition by ID

GET/api/custom-fields/{id}

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
id Number Custom field unique ID
curl -X GET "https://yoursite.com/api/custom-fields/123" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
{
  "id": "3",
  "title": "Region",
  "options": "North,South",
  "field_type": "select",
  "related_to": "clients",
  "sort": "1",
  "required": "0",
  "deleted": "0"
}

Error-Response:

HTTP/1.1 404 Not Found
{ "status": false, "messages": { "error": "No data were found" } }
MethodGET
Path/api/custom-fields/{id}
GroupCustom Fields
Sincev1.0.0
Defined inRestApi/Controllers/CustomFieldsController.php