Get a Lead Field’s Properties

Returns the properties (schema name, display name, data type, max length, created on date, modified date, etc.) of a specific lead field.

You have to pass the schema name of the lead field you want to retrieve in the API URL.

If you’re looking for the schema names of all lead Fields, use the Get Meta Data API.


Copy URL

URL Parameters

Parameter Description
SchemaName Schema name of the lead field.


200 OK

Content-Type: application/json

        "Entity": "1",
        "SchemaName": "Phone",
        "DisplayName": "Phone Number",
        "DataType": "Phone",
        "IsMandatory": false,
        "MaxLength": "10",
        "EntityAttributeId": "573473a6-797d-11e4-b2b6-22000a940c0c",
        "Name": "Phone",
        "Description": "Phone Number",
        "EntityAttributeType": 1,
        "RenderType": 6,
        "RenderTypeTextValue": "Phone",
        "IsVisible": true,
        "IsSearchable": true,
        "ShowInMailMerge": true,
        "RangeMin": "10",
        "AllowMultiple": true,
        "ShowInImport": true,
        "ShowInQuickAdd": true,
        "ShowInQuickSearch": true,
        "Txt_Row": 0,
        "Txt_Col": 0,
        "OwnerID": "563fc838-797d-11e4-b2b6-22000a940c0c",
        "CreatedBy": "563fc838-797d-11e4-b2b6-22000a940c0c",
        "CreatedOn": "/Date(1417453996000+0000)/",
        "ModifiedBy": "563fc7e8-797d-11e4-b2b6-22000a940c0c",
        "ModifiedOn": "/Date(1457006650000+0000)/",
        "OwnerIdName": "System",
        "CreatedByName": "System",
        "ModifiedByName": "Prashant Singh",
        "IsLeadIdentifier": true,
        "LockAfterCreate": 1,
        "UseInLeadClone": false,
        "IsSortable": true

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.