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 –
| Singapore | https://api.leadsquared.com/v2/ |
| United States | https://api-us11.leadsquared.com/v2/ |
| India (Mumbai) | https://api-in21.leadsquared.com/v2/ |
| India (Hyderabad) | https://api-in22.leadsquared.com/v2/ |
| Ireland | https://api-ir31.leadsquared.com/v2/ |
| Canada | https://api-ca12.leadsquared.com/v2/ |
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
URL
GET
https://{host}/v2/Authentication.svc/UserByAccessKey.Get?accessKey=AccessKey&secretKey=SecretKey
Response
200 OK
Content-Type: application/json
{
"Class":"1",
"Group":"1",
"SubRegionId":"1",
"Id":"1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"Name":"Yogesh",
"PassPhrase":"sri.sudhan@leadsquared.com",
"Role":"Administrator",
"EmailAddress":null,
"SessionId":"",
"TimeZone":"Asia/Kolkata",
"TokenId":null,
"Type":"ApplicationUser",
"OrgDisplayName":"Education 101",
"OrgId":"3b1041a3-8374-11e7-8758-0a106ee76b21",
"OrgShortCode":"22824",
"OrgUniqueName":"t20170817174751",
"DefaultCountryCode":"91",
"Website":"lshelp.staging.wpengine.com",
"Street1":"123 Street",
"Street2":"",
"City":"Bengaluru",
"State":"Karnataka",
"Country":"India",
"Phone":"+91-8556010497",
"Fax":"",
"Zip":"",
"AssociatedPhoneNumbers":"+91-9000000000",
"RestrictedFeatures":null,
"CustomerType":"LSQ - Internal",
"Plan":null,
"UserType":"Regular",
"MobileServiceURLs":{
"ReportsURL":"https://reports.leadsquared.com/CommonServices",
"FileUploadURL":"https://files-in21.leadsquared.com/File/Upload",
"MobileNotificationURL":"https://mobile-notifications.leadsquared.com/RegisterDevice.aspx",
"V1ServiceURL":"https://mobileapi-in21.leadsquared.com/v1",
"V2ServiceURL":"https://mobileapi-in21.leadsquared.com/v2",
"SalesTrackedURL":"https://field-sales-tracker.leadsquared.com",
"MobileReportListURL":"https://mobilereportlist.leadsquared.com/MobileReports.svc",
"AceURL":"https://analytics-in21.leadsquared.com/goals"
},
"LSQCommonServiceURLs":{
"api":"api-in21.leadsquared.com",
"app":"in21.leadsquared.com",
"tracking":"web-in21.mxradon.com",
"telephony":"telephony-in21.leadsquared.com",
"analyticsapi":"analyticsapi-in21.leadsquared.com",
"loginApp":"https://login-in21.leadsquared.com"
},
"AllowedClusters":null,
"AllowedRegions":null
}
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. |
