Get Sales Groups

This API lets you retrieve all sales groups in your LeadSquared account.

Note: If you pass an optional “UserId” parameter in the query string, all sales group the specified user is part of will be retrieved. To get User Ids, see User Management.

 

API URL

GET
https://{host}/v2/UserGroup.svc/Retrieve?accessKey=AccessKey&secretKey=SecretKey&UserId=UserId
Copy URL

URL Parameters

Parameter Description
UserId Unique identifier of a user.

Response

200 OK

Content-Type: application/json

{
  "RecordCount": 2,
  "UserGroups": [
    {
      "GroupId": "ed3ea545-b1fa-11e9-9371-0666b2d6ef5e",
      "Name": "My First Sales Group",
      "Description": "Sales Group for India",
      "CreatedOn": "2019-07-29 12:18:09",
      "UserCount": "3"
    },
    {
      "GroupId": "2f9f9b6b-bb45-11e8-a10d-06ee26114d5a",
      "Name": "International Sales Group",
      "Description": "Sales group for APAC Region",
      "CreatedOn": "2018-09-18 01:17:26",
      "UserCount": "605"
    }
  ]
}

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.