# Get Company Custom Field Definition

## Get Company Custom Field Definition

<mark style="color:green;">`POST`</mark> `[PlatformAddress]/api/1.0/contact?action=getCompanyCustomFieldDefinition`

Get the definition of custom field

{% tabs %}
{% tab title="200 " %}

```
[
    {
        "fieldId": 47,
        "fieldType": 3,
        "displayName": "Test Multiple",
        "isRequired": false,
        "isActive": true,
        "sortOrder": 1,
        "selectValues": {
            "Test 1": "Test 1",
            "Test 2": "Test 2"
        },
        "fileTypes": null
    },
    {
        "fieldId": 1,
        "fieldType": 0,
        "displayName": "TIN Number",
        "isRequired": false,
        "isActive": true,
        "sortOrder": 2,
        "selectValues": null,
        "fileTypes": null
    },
    {
        "fieldId": 2,
        "fieldType": 4,
        "displayName": "Accountant Address",
        "isRequired": false,
        "isActive": false,
        "sortOrder": 3,
        "selectValues": null,
        "fileTypes": null
    },
    {
        "fieldId": 3,
        "fieldType": 5,
        "displayName": "Your Birth Date",
        "isRequired": true,
        "isActive": true,
        "sortOrder": 4,
        "selectValues": null,
        "fileTypes": null
    },
    {
        "fieldId": 45,
        "fieldType": 6,
        "displayName": "Profile Picture",
        "isRequired": false,
        "isActive": true,
        "sortOrder": 5,
        "selectValues": null,
        "fileTypes": [
            "images"
        ]
    }
]
```

{% endtab %}
{% endtabs %}

## Returns

An array of objects with the following properties

| Property     | Description                                                                                     |
| ------------ | ----------------------------------------------------------------------------------------------- |
| fieldId      | The unique identifier for this custom field                                                     |
| fieldType    | [The type of this field](https://developer.ivvy.com/get-custom-field-definition#types-of-field) |
| displayName  | The name of this field                                                                          |
| isRequired   | If this field is required or not                                                                |
| isActive     | If this field is active or not                                                                  |
| sortOrder    | Order to display this field                                                                     |
| selectValues | Values that can be selected with select fields                                                  |
| fileTypes    | Types of files that can be uploaded with the file custom field                                  |

## Types of field

* 0 = Small Text
* 1 = Large Text
* 2 = Single Select
  * Valid options are provided in the ‘selectValues’ key
* 3 = Multiple Select
  * Valid options are provided in the ‘selectValues’ key
* 4 = Address
* 5 = Date
* 6 = File
  * Valid file types are provided in the ‘fileTypes’ key
* 7 = Static Text
  * Values cannot be set for this type
* 8 = Whole Number
* 9 = Large Select

This call will return an array of custom fields available on the account. The result will have the fieldId which is the unique field identifier for the specific field, as well as the display name and any options required for each field.

As part of the field definition there is a ‘fieldType’ property which can be resolved to the following types

* 0 = Small Text
* 1 = Large Text
* 2 = Single Select
  * Valid options are provided in the ‘selectValues’ key
* 3 = Multiple Select
  * Valid options are provided in the ‘selectValues’ key
* 4 = Address
* 5 = Date
* 6 = File
  * Valid file types are provided in the ‘fileTypes’ key
* 7 = Static Text
  * Values cannot be set for this type
* 8 = Whole Number
* 9 = Large Select