Skip to main content

getCustomFieldsDefinitions

This method retrieves the custom fields definitions.

Parameters

No input parameters are required.

Return value

This method returns an Object containing a list of the custom fields definitions with the following structure:

  • id - the ID of the custom field

  • name - the name of the custom field

Example

Request:

  {
       "params": {
       },
       "jsonrpc": "2.0",
       "method": "getCustomFieldsDefinitions",
       "id": "6435c228-73b0-4e72-9a2a-8716cc58c883"
  }  

Response:

  {
      "id":"6435c228-73b0-4e72-9a2a-8716cc58c883",
      "jsonrpc":"2.0",
      "result": [
            {
               "name": "referenceID",
               "id": "5d8800330ea1de72721f9922"
            },
            {
               "name": "vertical",
               "id": "5d91f4350ea1de6353701f62"
            },
            {
               "name": "partner_type",
               "id": "5d91f2a90ea1de37ee1153f2"
            },
            {
               "name": "security_level",
               "id": "5d91f70b0ea1de67a438aba2"
            }
       ]
  }