API - Get Members
POST https://gaggle.email/api/v2/get-members
Get the list of members for a group
Request
Parameters
| api_key (string) | Your API key (see Introduction) |
| group_address (string) |
The @gaggle.email address of the group |
Example
This example shows fetching members for a group.
POST https://gaggle.email/api/v2/get-members
{
'api_key': <your-api-key>,
'group_address': 'test-group@gaggle.email'
}
Response
Status code 200 signifies success.
| status (string) | success: members fetched successfully failed: no members fetched |
| message (string) | optional error message |
{
'status': 'failed',
'message': 'you are not an administrator of the group'
}