v1

latestOpenAPI 3.0.02026-08-061280285.2 KB

Job APIs

Lists all job custom fields available.

get/api/external/job/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/job/custom-field/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"id":65,"name":"JobCFDate","type":"date"},{"id":64,"name":"Number field","type":"number"},{"choices":[{"id":683,"name":"Active"},{"id":684,"name":"Lead"},{"id":720,"name":"New Status Stuff"},{"id":748,"name":"choice 1"}],"id":52,"name":"Status","type":"single_select"},{"id":63,"name":"Input field","type":"long_text"},{"id":50,"name":"Active","type":"yes_no"}],"total_items":7}}

Example response

{
  "data": [
    {
      "id": 65,
      "name": "JobCFDate",
      "type": "date"
    },
    {
      "id": 64,
      "name": "Number field",
      "type": "number"
    },
    {
      "choices": [
        {
          "id": 683,
          "name": "Active"
        },
        {
          "id": 684,
          "name": "Lead"
        },
        {
          "id": 720,
          "name": "New Status Stuff"
        },
        {
          "id": 748,
          "name": "choice 1"
        }
      ],
      "id": 52,
      "name": "Status",
      "type": "single_select"
    },
    {
      "id": 63,
      "name": "Input field",
      "type": "long_text"
    },
    {
      "id": 50,
      "name": "Active",
      "type": "yes_no"
    }
  ],
  "total_items": 7
}