Get user defined field

GET /closeAPI/api/close/udf/{id}

Path parameters

id integer Required

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer
- name string
- sourceTypeId integer
- appId integer
- type string
  
  Values are TEXT, NUMBER, or CUSTOM_VALUES.
- customValueGroup object
  
  Hide customValueGroup attributes Show customValueGroup attributes object
  
  id integer
  
  name string
  
  values array[object]
  
  Hide values attributes Show values attributes object
  
  id integer
  
  name string Required
  
  shortName string
  
  exportValue string Required
  
  order integer
- isRequired boolean
- order integer
- isActive boolean
- isReported boolean
- isUsed boolean

GET /closeAPI/api/close/udf/{id}

curl \
 --request GET 'https://customer.trintech.com/closeAPI/api/close/udf/{id}'

Response examples (200)

{
  "id": 42,
  "name": "string",
  "sourceTypeId": 42,
  "appId": 42,
  "type": "TEXT",
  "customValueGroup": {
    "id": 42,
    "name": "string",
    "values": [
      {
        "id": 42,
        "name": "string",
        "shortName": "string",
        "exportValue": "string",
        "order": 42
      }
    ]
  },
  "isRequired": true,
  "order": 42,
  "isActive": true,
  "isReported": true,
  "isUsed": true
}