get https://{host}/v2/userGroup2/search
Retrieves the details of a specific group using the unique ID or external ID of the group.
Make sure that you have appropriate access control configured. For more information, see access group documentation.
API endpoint
To search for a group based on the group name: {host}/userGroup2/search?q={query parameter}
To search for a group based on group ID or external ID: {host}/userGroup2?id={query parameter}
This allows you to search for any group using group_id, group_name, group_external id, and primary member email id/ mobile number/ card number.
Query parameters
Parameter | Type | Description |
---|---|---|
q* | string | The name of the group. |
id* | integer | The group or external ID of the group. |
offset | integer | The starting index for data retrieval. |
limit | integer | The maximum number of items to be retrieved. |
Note :Any one among the parameters marked with * is mandatory.
Response parameters
Parameter | Description |
---|---|
pagination | An object that contains details about the pagination. |
limit | The maximum number of records returned per page. |
offset | The starting point in the list of records. |
total | The total number of records. |
data | An array containing the data records. |
groupId | The unique identifier of the group. |
groupName | The name of the group. |
groupStatus | The status of the group (e.g., ACTIVE). |
groupExternalId | An external identifier for the group. |
firstName | The first name of the primary member of the group. |
lastName | The last name of the primary member of the group. |
primaryMemberId | The unique identifier of the primary member. |
The email address of the primary member. | |
mobile | The mobile number of the primary member. |
totalMembers | The total number of members in the group. |
warnings | An array containing any warning messages. |
errors | An array containing any error messages. |
id | The unique identifier of the group. |
lifeTimePurchases | The total amount of purchases made by the group in its lifetime. |
totalActiveMembers | The total number of currently active members in the group. |
totalExitedMembers | The total number of members who have left the group. |
defaultGroup | A boolean value indicating whether the group is a default one for the user. |