Home → API Documentation → Miscellaneous API Calls → api/ReturnCustomFields
11.5. api/ReturnCustomFields
This API call retrieves the available custom fields for contact, company or event records. Only active fields that can be edited are returned.
Use this endpoint to obtain the FieldGUID required by api/UpdateCustomField. This call returns field definitions, including their names and types; it does not return values stored against individual records.
Parameters To Submit
All parameters are required and cannot be empty.
| Parameter | Parameter Help | Parameter Data Type |
| CallType | The record type: Contact, Company or Event. | String |
| API Key |
Return Response
This API call will return in the ResponseMessage an array of the following fields.
| Field | Field Help |
| FieldGUID | The field identifier to submit when updating a value. |
| FieldName | The display name of the field. |
| FieldType | The field type. Checkbox fields are returned as Boolean. |
Example of the array contained in ResponseMessage:
[
{"FieldGUID":"F2A90DB2","FieldName":"Are you happy to receive marketing communications?","FieldType":"Boolean"},
{"FieldGUID":"FD33ADE3","FieldName":"What are you interested in hearing about?", "FieldType":"Dropdown - Multi Select"}
]
Field identifiers and available options depend on your CRM system.