Get Users
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the list of users in your LeadSquared account.
You’ll see a “StatusCode” parameter in the response body –
- “StatusCode”:0 signifies that the user is active.
- “StatusCode”:1 signifies that the user is inactive.
API URL
URL
GET
https://{host}/v2/UserManagement.svc/Users.Get?accessKey=AccessKey&secretKey=SecretKey
Response
200 OK
Content-Type: application/json
[
{
"ID":"abc1d2ef-3g0h-45i6-j0kl-07m89o1pq2r3",
"FirstName":"Bob",
"LastName":"Doe",
"EmailAddress":"bobdoe@example.com",
"Role":"Sales_User",
"StatusCode":0,
"MemberOfGroups":[
"Test"
],
"Tag":null,
"IsPhoneCallAgent":false
},
{
"ID":"stu1v2wx-3y0z-45a1-b0cd-02e34f5gh6i7",
"FirstName":"Frank",
"LastName":"Doe",
"EmailAddress":"frankdoe@example.com",
"Role":"Administrator",
"StatusCode":0,
"Tag":null,
"IsPhoneCallAgent":false
}
]
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. |
