Get active members | Kollo

{
  "body": {
    "currentMembership": {
      "membershipId": "8aa5134c-1747-4c54-8e3a-d3aa3dd361f8",
      "customerId": "cad93347-d28d-49bc-8960-1c326ad9832e",
      "groupId": "5d3a0675-fa22-4314-a90d-1aec9ad65b5e",
      "status": "active",
      "autoContribute": false,
      "position": 1,
      "role": "admin"
    },
    "activeMemberships": [
      {
        "membershipId": "b1dfc32e-a510-432d-b93f-d099ac5c851a",
        "customerId": "6bddd666-c059-4b01-b171-54ced176e61a",
        "groupId": "5d3a0675-fa22-4314-a90d-1aec9ad65b5e",
        "status": "active",
        "autoContribute": false,
        "position": 2,
        "role": "member",
        "customer": {
          "customerId": "6bddd666-c059-4b01-b171-54ced176e61a",
          "firstName": "Dolapo",
          "lastName": "Daranijo",
          "fullName": "Dolapo Daranijo",
          "avatar": "https://ui-avatars.com/api/?name=Dolapo+Daranijo&background=random"
        },
        "pendingSwap": {
          "membershipSwapId": "2878cd7f-357b-4c08-bb6c-a1797f0548ba",
          "groupId": "5d3a0675-fa22-4314-a90d-1aec9ad65b5e",
          "requesterId": "b1dfc32e-a510-432d-b93f-d099ac5c851a",
          "targetId": "8aa5134c-1747-4c54-8e3a-d3aa3dd361f8",
          "requesterPosition": 2,
          "targetPosition": 1,
          "status": "pending"
        }
      }
    ]
  },
  "message": "Rotating group active memberships fetched"
}

This endpoint retrieves all active members of a rotating group, including the current user’s membership details and information about all other active members in the group.

Endpoint

Method: GET
Path: {{host}}/rotating_groups/{{group_id}}/active_members

Required Variables

host - The base URL of the API server
group_id - The unique identifier of the rotating group
token - Authentication token (used in request headers)

Response Structure

The response contains two main objects:

currentMembership

Details about the authenticated user’s membership in the rotating group:

membershipId (string) - Unique identifier for the membership
customerId (string) - ID of the customer/user
groupId (string) - ID of the rotating group
status (string) - Membership status (e.g., “active”)
autoContribute (boolean) - Whether automatic contributions are enabled
position (number) - Member’s position in the rotation cycle
role (string) - User’s role in the group (“admin” or “member”)

activeMemberships

An array containing all active members in the rotating group. Each member object includes:

membershipId (string) - Unique identifier for the membership
customerId (string) - ID of the customer/user
groupId (string) - ID of the rotating group
status (string) - Membership status
autoContribute (boolean) - Whether automatic contributions are enabled
position (number) - Member’s position in the rotation cycle
role (string) - User’s role (“admin” or “member”)
customer (object) - Detailed customer information:
- customerId (string) - Customer’s unique ID
- firstName (string) - Customer’s first name
- lastName (string) - Customer’s last name
- fullName (string) - Customer’s full name
- name (string) - Customer’s display name
- avatar (string) - URL to customer’s avatar image
- isSuspended (boolean) - Whether the customer account is suspended

Success Response

Status Code: 200 OK

The response includes a success message and the body containing both the current membership and all active memberships with full customer details.

# Get Active Members This endpoint retrieves all active members of a rotating group, including the current user's membership details and information about all other active members in the group. ## Endpoint **Method:** `GET` **Path:** `{{host}}/rotating_groups/{{group_id}}/active_members` ## Required Variables - `host` - The base URL of the API server - `group_id` - The unique identifier of the rotating group - `token` - Authentication token (used in request headers) ## Response Structure The response contains two main objects: ### currentMembership Details about the authenticated user's membership in the rotating group: - `membershipId` (string) - Unique identifier for the membership - `customerId` (string) - ID of the customer/user - `groupId` (string) - ID of the rotating group - `status` (string) - Membership status (e.g., "active") - `autoContribute` (boolean) - Whether automatic contributions are enabled - `position` (number) - Member's position in the rotation cycle - `role` (string) - User's role in the group ("admin" or "member") ### activeMemberships An array containing all active members in the rotating group. Each member object includes: - `membershipId` (string) - Unique identifier for the membership - `customerId` (string) - ID of the customer/user - `groupId` (string) - ID of the rotating group - `status` (string) - Membership status - `autoContribute` (boolean) - Whether automatic contributions are enabled - `position` (number) - Member's position in the rotation cycle - `role` (string) - User's role ("admin" or "member") - `customer` (object) - Detailed customer information: - `customerId` (string) - Customer's unique ID - `firstName` (string) - Customer's first name - `lastName` (string) - Customer's last name - `fullName` (string) - Customer's full name - `name` (string) - Customer's display name - `avatar` (string) - URL to customer's avatar image - `isSuspended` (boolean) - Whether the customer account is suspended ## Success Response **Status Code:** `200 OK` The response includes a success message and the body containing both the current membership and all active memberships with full customer details.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

bodyobject

messagestring

Response Structure

The response contains two main objects:

currentMembership

Details about the authenticated user’s membership in the rotating group:

membershipId (string) - Unique identifier for the membership

customerId (string) - ID of the customer/user

groupId (string) - ID of the rotating group

status (string) - Membership status (e.g., “active”)

autoContribute (boolean) - Whether automatic contributions are enabled

position (number) - Member’s position in the rotation cycle

role (string) - User’s role in the group (“admin” or “member”)