Get a Lead Field’s Properties
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
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.
To get the properties of an Object Type field, pass LeadType as the schema name.
Note:
- If Object Types are enabled on your account, in the response, the
LeadTypeis OT_0 by default. This means leads are the default Object Type. If you create custom object types, theLeadTypeis OT_1, OT_2, and so on. - If Object Types are not enabled in your account, you do not see any object type parameters in the response.
API URL
URL
GET
https://{host}/v2/LeadManagement.svc/LeadsMetaData.Get?accessKey=AccessKey&secretKey=SecretKey&schemaName=SchemaName
URL Parameters
| Parameter | Description |
|---|---|
| SchemaName | Schema name of the lead field. |
Response
200 OK
Content-Type: application/json
[
{
"Entity":"1",
"SchemaName":"LeadType",
"DisplayName":"Object Type",
"DataType":"Select",
"IsMandatory":true,
"Options":[
{
"Value":"OT_0"
},
{
"Value":"OT_1"
},
{
"Value":"OT_3"
},
{
"Value":"OT_4"
},
{
"Value":"OT_5"
}
],
"MaxLength":"50",
"EntityAttributeId":"c88c46fd-5b5a-11f0-91df-068012126923",
"Name":"LeadType",
"EntityAttributeType":1,
"RenderType":13,
"RenderTypeTextValue":"Dropdown",
"IsVisible":true,
"IsSearchable":true,
"ShowInMailMerge":true,
"DefaultValue":"OT_0",
"AllowMultiple":true,
"ShowInImport":true,
"ShowInQuickAdd":true,
"Txt_Row":0,
"Txt_Col":0,
"OwnerID":"e0b37c74-5b1c-11f0-a986-06c72fc46c23",
"CreatedBy":"e0b37c74-5b1c-11f0-a986-06c72fc46c23",
"CreatedOn":"/Date(1751910591000+0000)/",
"ModifiedBy":"e0b37c74-5b1c-11f0-a986-06c72fc46c23",
"ModifiedOn":"/Date(1751910592000+0000)/",
"OwnerIdName":"System",
"CreatedByName":"System",
"ModifiedByName":"System",
"IsLeadIdentifier":false,
"LockAfterCreate":2,
"UseInLeadClone":true,
"IsSortable":true
}
]
HTTP Response Codes
| 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. |
