v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Deal APIs

Lists all Deal custom fields available.

get/api/external/deal/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/deal/custom-field/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"id":65,"name":"DealCFDate","type":"date"},{"id":64,"name":"Number field","type":"number"},{"choices":[{"children":[],"id":8,"name":"choice1"},{"children":[],"id":8,"name":"choice2"}],"id":52,"name":"Single Select Field","type":"single_select"}],"total_items":3}}

Example response

{
  "data": [
    {
      "id": 65,
      "name": "DealCFDate",
      "type": "date"
    },
    {
      "id": 64,
      "name": "Number field",
      "type": "number"
    },
    {
      "choices": [
        {
          "children": [],
          "id": 8,
          "name": "choice1"
        },
        {
          "children": [],
          "id": 8,
          "name": "choice2"
        }
      ],
      "id": 52,
      "name": "Single Select Field",
      "type": "single_select"
    }
  ],
  "total_items": 3
}