Authenticate a User

Accepts a user’s Access Key and Secret Key to –

  • Verify if the user exists in LeadSquared. You’ll get a “401 Unauthorized” response if –
    • The user doesn’t exist.
    • The user exists and is inactive.
  • Return user details.
  • Return the region-specific API host you have to use for all other calls. The parameter “LSQCommonServiceURLs” in response body contains the API host and web app host URL. Your API host will be one of –
    • https://api-us11.leadsquared.com
    • https://api-in21.leadsquared.com
    • https://api.leadsquared.com

Note: Although other API calls will fail if you pass an API host that isn’t specific to your region, this call won’t. Use this API to find out your region specific API host.

API URL

GET
https://{host}/v2/Authentication.svc/UserByAccessKey.Get?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Response

200 OK

Content-Type: application/json

{
	"Id":"3b1041fb-8374-11e7-8758-0a106ee76b21",
	"Name":"Vir Singh",
	"PassPhrase":"virkdsingh@example.com",
	"Role":"Administrator",
	"SessionId":"2cbaefdc-20fd-11e8-871e-02bf1924461c",
	"TimeZone":"Asia/Kolkata",
	"TokenId":null,
	"Type":"ApplicationUser",
	"OrgDisplayName":"Education 101",
	"OrgId":"3b1041a3-8374-11e7-8758-0a106ee76b21",
	"OrgShortCode":"22824",
	"OrgUniqueName":"t20170817174751",
	"DefaultCountryCode":"91",
	"Website":"",
	"Street1":"123 Street",
	"Street2":"",
	"City":"Bengaluru",
	"State":"Karnataka",
	"Country":"India",
	"Phone":"+91-8556010333",
	"Fax":"",
	"Zip":"",
	"AssociatedPhoneNumbers":"+91-1111222233,
	+91-8222121122",
	"RestrictedFeatures":null,
	"CustomerType":"LSQ - Internal",
	"Plan":null,
	"UserType":"Regular",
	"LSQCommonServiceURLs":{
		"api":"api-in21.leadsquared.com",
		"app":"in21.leadsquared.com",
		"tracking":"web-in21.mxradon.com",
		"telephony":"telephony-in21.leadsquared.com"
	}
}

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.