Get a List of Custom Fields

Retrieve details of custom fields for different entities.

Query String Parameters

Name	Type	Description	Required
Action	String	ListCustomFields	Required
EntityTypeId	int	This parameter selects an entity (ie Contact).	Required
EntityGroupId	int	This parameter specifies the actual "group" of custom fields. See note.	Required

Filter Parameters

Use the EntityTypeId and EntityGroupId filter parameters to filter the response for specific set of custom field definitions. Both parameters must be supplied to successfully filter the response data.

For example, if you want to look at the custom fields defined for Contacts use EntityTypeId = 1.

note

These are the custom field definitions (which are on the contact group, job type etc) not the actual custom field values on individual contacts.

note

EntityGroupId: This parameter specifies the actual "group" of custom fields to be returned. For example - when entityTypeId =1 (Contact), EntityGroupId is the contact group ID (which the custom fields are defined against).

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ListCustomFields&EntityTypeId=1&EntityGroupId=14971

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "id": 432632,
      "label": "System Resource",
      "entitytype": "Contact",
      "entitytypeid": 1,
      "entitygroupid": 14971,
      "type": "SystemList",
      "typeid": 20,
      "mandatory": false,
      "cfdefault": "{\"id\":108103,\"label\":\" Joe Bloggs\",\"type\":0}",
      "Order": 0
    },
    {
      "id": 1112959,
      "label": "Test21",
      "entitytype": "Contact",
      "entitytypeid": 1,
      "entitygroupid": 14971,
      "type": "Text",
      "typeid": 3,
      "mandatory": false,
      "cfdefault": "",
      "Order": 1
    }
  ]
}