get
https://{host}/v2/userGroup2/members
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this API to retrieve all members of a user group. The response includes each member's role (PRIMARY or SECONDARY), identifiers, permissions, and points contributed to the group.
This API supports the following:
- View all members of a group using the group's internal ID.
- View card details for each member using
includeCardDetails=true. - View card status information (active/suspended status, reason, timestamps) using
includeStatusDetails=true. - Paginate through large groups using
paginationDetails=truewithlimitandoffset. - Sort results or filter by member join date using
fromDateandtoDate.
The response also includes each member's email, mobile number, and list of registered identifiers.
Make sure you have the appropriate access control configured. For more information, see access group documentation.
Current membership records onlyThe API returns only the current membership status for each member. If a member leaves and re-enrolls, only the latest active membership record is shown. Historical membership records (such as a previous EXITED status) are not included in the response.
Example request
curl -L 'https://eu.api.capillarytech.com/v2/userGroup2/members?source=INSTORE&identifierName=id&identifierValue=3948622' \
-H 'Authorization: Basic {base64-encoded-credentials}'curl -L 'https://eu.api.capillarytech.com/v2/userGroup2/members?source=INSTORE&identifierName=id&identifierValue=3948622&includeCardDetails=true&includeStatusDetails=true&paginationDetails=true&sortOrder=DESC&limit=20' \
-H 'Authorization: Basic {base64-encoded-credentials}'Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
source | Enum | Yes | Source in which the group identifier is registered. Supported values: INSTORE, MARTJACK, WECHAT, FACEBOOK, WEB_ENGAGE, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. Case-sensitive. |
identifierName | Enum | Yes | Identifier type used to look up the group. Supported value: id (internal group ID). |
identifierValue | String | Yes | Value of the identifier specified in identifierName. For example, if identifierName is id, pass the numeric group ID. |
includeCardDetails | Boolean | Optional | Pass true to include card details for each member in the response. Defaults to false. |
includeStatusDetails | Boolean | Optional | Pass true to include customer status details for each member's cards in the response. Defaults to false. |
paginationDetails | Boolean | Optional | Pass true to include a pagination object in the response. Defaults to false. |
limit | Integer | Optional | Maximum number of members to return per page. Used with paginationDetails=true. |
offset | Integer | Optional | Starting index for paginated results. Used with paginationDetails=true. |
sortBy | String | Optional | Field to sort results by. Pass IS_PRIMARY to list the primary member first. |
sortOrder | Enum | Optional | Sort direction. Supported values: ASC, DESC. Defaults to DESC. |
fromDate | DateTime | Optional | Start of the date range to filter members by join date. Format: YYYY-MM-DD HH:MM:SS. |
toDate | DateTime | Optional | End of the date range to filter members by join date. Format: YYYY-MM-DD HH:MM:SS. |
Response parameters
| Field | Type | Description |
|---|---|---|
.pagination | Object | Pagination details. Present only when paginationDetails=true. |
..limit | Integer | Maximum number of records returned per page. |
..offset | Integer | Starting index of the current page. |
..sortBy | String | Field used to sort results. |
..sortOrder | String | Sort direction: ASC or DESC. |
..total | Integer | Total number of members in the group. |
.data | Array | List of member objects in the user group. |
..fleetUserId | Integer | Unique identifier of the member (customer ID). |
..firstName | String | First name of the member. |
..lastName | String | Last name of the member. |
..joinedOn | String | Date the member joined the group, in YYYY-MM-DD format. |
..permissions | String | Comma-separated list of permissions assigned to the member. Possible values: allow_points_redemption, allow_points_transfer, block_points_redemption, block_points_transfer. |
..pointsContributed | Number | Total points contributed by the member to the group. |
..email | String | Email address of the member. |
..mobile | String | Mobile number of the member, including country code. |
..role | String | Role of the member in the group. Possible values: PRIMARY, SECONDARY. |
..roleCode | String | Short code for the member's role as configured in the hierarchy definition. |
..identifiers | Array | List of registered identifiers for the member. |
...type | String | Identifier type. Possible values: mobile, email, externalId, cardnumber. |
...value | String | Value of the identifier. |
..cards | Array | Card objects owned by the member. Present only when includeCardDetails=true. |
...cardId | Integer | Unique identifier for the card. |
...issuedDate | String | Date and time the card was issued, in ISO 8601 format, returned in the server time zone. EU server example: 2022-05-05T17:45:58+05:30 → 05 May 2022, 17:45:58 (IST)Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
...createdDate | String | Date the card record was created, in YYYY-MM-DD format. |
...expiryDays | Integer | Number of days from issuance until card expiry. |
...expiryDate | String | Date and time the card expires, in ISO 8601 format, returned in the server time zone. |
...seriesName | String | Name of the card series the card belongs to. |
...seriesId | Integer | Unique identifier of the card series. |
...seriesCode | String | Code of the card series. |
...cardNumber | String | Unique card number. |
...type | String | Type of card. Possible values: DIGITAL, PHYSICAL. |
...customerId | Integer | Customer ID of the member the card is issued to. |
...maxActiveCards | Integer | Maximum number of active cards allowed for this series. |
...orgId | Integer | Unique identifier of the organisation. |
...entityId | Integer | Unique identifier of the entity associated with the card. |
...customFields | Object | Key-value pairs of custom field data associated with the card. |
...transactionNotAllowed | Boolean | Indicates whether transactions are blocked on this card. |
...statusInfo | Object | Status details of the card. Present only when includeStatusDetails=true. |
....id | Integer | Unique identifier of the card status record. |
....isActive | Boolean | Indicates whether the current card status is active. |
....label | String | User-defined status label (e.g., ACTIVE, SUSPENDED). |
....status | String | System-defined status code. Possible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, NOT_ISSUED. |
....labelId | Integer | Unique identifier of the status label. |
....reason | String | Reason for the current card status. |
....createdBy | Integer | ID of the entity that created the card status. |
....createdOn | String | Date and time the card status was created, in ISO 8601 format. |
....autoUpdateTime | String | Date the card status was last auto-updated, in YYYY-MM-DD format. |
....entityId | Integer | Card ID associated with this status record. |
....actions | Array | List of actions associated with this card status. |
..inActive | Boolean | Indicates whether the member is active in the group. true means active; false means inactive. |
..primaryMember | Boolean | Indicates whether the member is the primary member. true for primary; false for secondary. |
.warnings | Array | List of warning messages, if any. |
.errors | Array | List of error messages, if any. |