LeadSquared Developer Centre


Get Users of a Sales Group

Lets you retrieve all users in a specified sales group.

  • You must pass the “GroupId” parameter in the query string. You can retrieve it using the Get Sales Groups API
  • The response will return all users present in the group along with their permissions.



GET https://{host}/v2/UserGroup.svc/RetrieveUsers?accessKey=AccessKey&secretKey=SecretKey&GroupId=GroupId

URL Parameters

Parameter Description
GroupId Unique identifier of a sales group


200 OK
Content-Type: application/json
  "RecordCount": 2,
  "GroupUsers": [
      "GroupId": "ed3ea545-b1fa-11e9-9371-0666b2d6ef5e",
      "GroupName": "My First Sales Group",
      "UserId": "00f9ac64-7ab3-11e8-8266-06ee26114d5a",
      "UserName": "Felice Gone",
      "ViewAllLeadsOfGroup": true,
      "ModifyAllLeadsOfGroup": true,
      "AddUsersToGroup": true,
      "CreateGroupAutomation": false
      "GroupId": "ed3ea545-b1fa-11e9-9371-0666b2d6ef5e",
      "GroupName": "My First Sales Group",
      "UserId": "027399ba-7ab2-11e8-8266-06ee26114d5a",
      "UserName": "Deangelo Rardon",
      "ViewAllLeadsOfGroup": true,
      "ModifyAllLeadsOfGroup": true,
      "AddUsersToGroup": false,
      "CreateGroupAutomation": 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.

On this page

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.