LeadSquared Developer Centre

ON THIS PAGE

API
Developer Apps

Get Metadata

Try it

Returns the properties of all lead fields. Use this API to –

Understand the schema structure of each lead field (for both system and custom fields).
Get the permissions and properties associated with each lead field.

Note:

The API output may be very large due to dropdown values in fields. You can pass an optional parameter excludeOptionSets=1 in the API URL if you don’t need to retrieve dropdown values. This will improve the API performance.
You can also find the schema names of system and custom lead fields on the LeadSquared UI by navigating to My Account>Settings>Customization>Lead Fields.

API URL

URL

GET https://{host}/v2/LeadManagement.svc/LeadsMetaData.Get? accessKey=AccessKey&secretKey=SecretKey

Response

200 OK

Content-Type: application/json

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.

GET https://{host}/v2/LeadManagement.svc/LeadsMetaData.Get?accessKey=Access Key&secretKey=Secret Key

URL Parameters

Response

You have not yet submited

Generate Code

PHP


<?php $curl = curl_init();
        curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.leadsquared.com/v2/LeadManagement.svc/LeadsMetaData.Get?',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_HTTPHEADER => array(
                "cache-control: no-cache",
            ),
        ));

        $response = curl_exec($curl);
        $err = curl_error($curl);
        curl_close($curl);
        if ($err) {
            echo "cURL Error #:" . $err;
        } else {
                echo $response;
        } ?>


var settings = {
"async": true,
"crossDomain": true,
"url": 'https://api.leadsquared.com/v2/LeadManagement.svc/LeadsMetaData.Get?',
"method": "GET",
"headers": {
            "Cache-Control": "no-cache",
        }
    }
$.ajax(settings).done(function (response) {
    console.log(response);
});

Generate Code