CustomFields

Gets a list of Custom Fields

Use this API call to get a list of custom fields metadata. The properties FIELD_NAME and FIELD_ORDER can be used to determine which fields belong to a particular object. A common problem API users have is to reference an invalid FIELD_NAME when referencing custom fields in a newly created or updated object. If you plan to use custom fields in your API based application, be sure you are working with valid custom field names. To add or update custom fields for your Insightly instance, you'll need to go to the web app to do so.

get/CustomFields/{objectName}

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared

Path parameters

objectNamestring required

Response

Request succeeded.

FIELD_NAMEstring required
FIELD_ORDERinteger required
FIELD_FORstring required
FIELD_LABELstring required
FIELD_TYPEstring required
FIELD_HELP_TEXTstring
DEFAULT_VALUEstring
EDITABLEboolean
VISIBLEboolean
JOIN_OBJECTstring

Changes

No recorded changes to this operation across all 1 revision of this API.