v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
SubAccount

Get community members .

get/v0.2.4/sub-account/community/members

Query parameters

communityIDinteger

Community ID

limitinteger

maximum number of users to return - default is 50

startAfterIdstring

ID of the last User Data retrieved - important for retrieivng subsequent pages

startBeforeIdstring

ID of the first User Data retrieved - important for retrieivng previous pages

Response

Success.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Community members retrieved successfully",
  "data": [
    {
      "parent": "qP3P6bjbjLZUMxVfxgEqzOF0hNM2",
      "feePercent": 0,
      "accountSecondCurrencies": [],
      "verified": true,
      "subscription": {
        "subscription_end_timestamp": {
          "_seconds": 1878974727,
          "_nanoseconds": 543000000
        },
        "subscription_start_timestamp": {
          "_seconds": 1721208327,
          "_nanoseconds": 543000000
        },
        "id": "partner-white-glove"
      },
      "isScrimUser": false,
      "subAccount": true,
      "preferredExchangeRate": false,
      "uid": "1f8581c9-98f4-49a0-82f9-2a27fb27bbf5",
      "approved": true,
      "createdDate": "2024-07-17T09:25:27.543Z",
      "joinDate": "2024-07-17T09:25:27.543Z",
      "meta": {},
      "approvals": [
        {
          "changedFields": [
            "all"
          ],
          "deviceTime": "7/17/2024",
          "timestamp": "2024-07-17T09:25:27.265Z"
        }
      ],
      "name": "Michael",
      "apiUseEnabled": true,
      "p_id": 3797254,
      "verification": {
        "status": "completed"
      },
      "points": 250,
      "badges": [
        "payment-innovator",
        "first-payout"
      ],
      "firstName": "Mide",
      "lastName": "Jones",
      "id": "1f8581c9-98f4-49a0-82f9-2a27fb27bbf5",
      "communities": [
        {
          "communityType": "free",
          "name": "Chimoney Ambassadors",
          "memberName": "checkout Chimoney",
          "id": 5,
          "membershipID": "23232323",
          "hasClaimedVoucher": true,
          "voucherCode": "CHIMER_X24"
        },
        {
          "communityType": "free",
          "name": "Chimoney Community",
          "memberName": "checkout Chimoney",
          "id": 4,
          "membershipID": "23232323",
          "hasClaimedVoucher": true,
          "voucherCode": "CHISQUAD-003"
        }
      ],
      "phoneNumber": "+2348130099444",
      "phone": "+2348130099444",
      "updatedDate": "2024-09-09T20:00:07.485Z"
    }
  ]
}