v1

latestOpenAPI 3.0.02026-08-061280285.2 KB

Client APIs

Lists all company custom fields.

get/api/external/client/custom-field/list

Query parameters

include_countstring

Count of total records

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/client/custom-field/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"id":236,"name":"Is active?","type":"yes_no"},{"choices":[{"id":731,"name":"ms1"},{"id":732,"name":"ms2"},{"id":733,"name":"ms3"},{"id":734,"name":"ms4"},{"id":798,"name":"s2"}],"id":56,"name":"Multi Select","type":"multi_select"},{"id":40,"name":"Expected Billing","type":"money"}],"total_items":3}}

Example response

{
  "data": [
    {
      "id": 236,
      "name": "Is active?",
      "type": "yes_no"
    },
    {
      "choices": [
        {
          "id": 731,
          "name": "ms1"
        },
        {
          "id": 732,
          "name": "ms2"
        },
        {
          "id": 733,
          "name": "ms3"
        },
        {
          "id": 734,
          "name": "ms4"
        },
        {
          "id": 798,
          "name": "s2"
        }
      ],
      "id": 56,
      "name": "Multi Select",
      "type": "multi_select"
    },
    {
      "id": 40,
      "name": "Expected Billing",
      "type": "money"
    }
  ],
  "total_items": 3
}