<< Return to help center
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.

GetCustomFields Function Definition

The GetCustomFields function is used to retrieve a list of all the custom contact/company fields you've created in your CRM.

When calling this function, the Function parameter sent to the API should be GetCustomFields. Because this function is very basic, we do not have example code, but if you have any questions, feel free to reach out and we'll be happy to help.


This function does not take any input parameters. You just need to call the function itself, and we'll return all of the values described below.

Output Values

This function will return an array with "Contact" and "Company" sub-arrays. These will define the different contact and company fields. The following info is provided for each custom field.

Note: Right now you cannot define different fields for contacts and companies so they will always be the same. In the future we will add the ability to add more types of custom fields (hence the "Type" info) and we'll add the ability to specify different fields for contacts and companies. Once that happens, the set of fields returned by this function will probably change.

  • CustomFieldId
  • Name
  • SortOrder - the order the fields appear in the CRM
  • Type - will always be "text" for now
  • Options - will always be null until we add support for more field types
Next up:
API, function, custom fields
How do I can you are you able to can I how to is it possible