Retrieve Custom Records and Associated Custom Fields

Custom records can contain custom fields. We provide the following endpoints to help retrieve a list of custom records and the fields in those records.

  • GET /custom-record-types
  • GET /custom-record-types/{typeId}/custom-record-fields
  • GET /custom-record-types/{typeId}/custom-records

The response for GET /custom-record-types looks like this. Note the internalId at the top which you can use as typeId:

[
   {
    "internalId": "67",
    "scriptId": "customrecord_assetlifetimes",
    "name": "FAM - Lifetimes",
    "type": {
      "value": "customRecordType"
    }
  },
  {
    "internalId": "74",
    "scriptId": "customrecord_ncfar_assetusage",
    "name": "FAM - Asset Usage",
    "type": {
      "value": "customRecordType"
    }
  },
  {
    "internalId": "279",
    "scriptId": "customrecord_pf_kb_sol_fb",
    "name": "KB Solution Feedback",
    "type": {
      "value": "customRecordType"
    }
  },
  {
    "internalId": "452",
    "scriptId": "customrecord_suitesocial_record",
    "name": "SuiteSocial Record",
    "type": {
      "value": "customRecordType"
    }
  }
]