Search for groups using the extended fields

Search for groups based on the extended fields associated with them.

The new API allows you to search for groups using their associated extended fields. By providing one or more extended fields, you can retrieve groups that match the specified criteria. The API works even if only a single extended field is supplied.

API endpoint example

https://eu.api.capillarytech.com/v2/userGroup2/extendedFieldSearch

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Access group resource: Read and write access to the User Group resource

Resource information

URI/v2/userGroup2
HTTP MethodPOST
PaginationYes
Batch supportNo
Rate limit informationNA

Request body parameters

Parameter
(Parameters marked with * are mandatory)
TypeDescription
extendedFields*ArrayAn array containing the extended fields used to retrieve groups associated with those fields. Note: Each extended field must be valid and created under the usergroup2 entity.
{
    "extendedFields": {
        "platinum": "40"
    }

}

Response parameters

ParameterDescription
paginationAn array containing pagination information for the response.
- limitThe maximum number of records to retrieve.
- offsetThe starting point for fetching records.
- totalThe total number of records available.
dataAn array containing the group details.
- groupIdThe unique identifier for the group. It is the same as entity ID.
- groupNameThe name of the group.
- groupStatusThe current status of the group. Example: ACTIVE, EXITED
- groupExternalIdThe external identifier for the group.
- primaryMemberIdThe unique identifier for the primary member of the group.
- totalMembersThe total number of members in the group.
- totalActiveMembersThe total number of active members in the group.
- extendedFieldsAn array containing extended field information related to the group.
warningsAn array containing warnings, if any.
errorsAn array containing errors, if any.
{
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 1
    },
    "data": [
        {
            "groupId": 51334,
            "groupName": "natwest14",
            "groupStatus": "ACTIVE",
            "groupExternalId": "natwest_16",
            "primaryMemberId": 558085086,
            "totalMembers": 1,
            "totalActiveMembers": 1,
            "extendedFields": {
                "platinum": 40
            }
        }
    ],
    "warnings": [],
    "errors": []
}

API-specific error codes

Error codeDescription
1661The extended fields array is empty.
91017The value of the extended field does not match the data type.
91016The extended field name is incorrect.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!