List members in a group

GET /groups/members/{groupid}/{page}

OAuth2

Get the members list and basic details. It returns up to 200 contacts per page.

Path parameters

groupid string Required

The group id you want to list
page string Required

The page number

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- groupId integer
- members array[object]
  
  Hide members attributes Show members attributes object
  
  userId integer
  
  firstname string
  
  middlename string
  
  lastname string
  
  gender string
  
  Can be empty also
  
  Values are Male, Female, or ORGANISATION.
  
  householdname string
  
  isOrganisation string
  
  Use the Household name when this is Y
  
  Values are Y or N.
  
  membership object
  
  Additional properties are allowed.
  
  Hide membership attributes Show membership attributes object
  
  code string
  
  Values are A, F, V, or P.
  
  text string
  
  Values are Administrator, Full member, View only, or Past Member.

GET /groups/members/{groupid}/{page}

curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/groups/members/310/5' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "groupId": 498,
  "members": [
    {
      "userId": 98739,
      "firstname": "Richard",
      "middlename": "string",
      "lastname": "Jones",
      "gender": "Male",
      "householdname": "string",
      "isOrganisation": "N",
      "membership": {
        "code": "A",
        "text": "View only"
      }
    }
  ]
}