Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search user groups by name, ID, and mobile number

Retrieves the details of a specific group using the unique ID or external ID of the group.

get/userGroup2/search

Query parameters

qstring required

To search for the group using group name. Note: One of the required parameters marked is mandatory.

idstring required

To search for the group using group id. Note: One of the required parameters is mandatory.

offsetstring

The starting index for data retrieval.

limitstring

The maximum number of items to be retrieved.

Response

200

OR
OR

Example response

{
  "pagination": {
    "limit": 10,
    "total": 1
  },
  "data": [
    {
      "groupId": 3839,
      "groupName": "Buklfleetgroup",
      "groupStatus": "ACTIVE",
      "groupExternalId": "bukl123",
      "firstName": "Rohan",
      "lastName": "Mahadar",
      "primaryMemberId": 134094571,
      "email": "tom.sawyer@capillarytech.com",
      "mobile": "917799889933",
      "totalMembers": 7
    }
  ]
}