Group Details

Brief description:

  • Retrieve detailed metadata for a specific group via API – fetch descriptions, member counts, activity stats, and settings in one call.

Endpoint

Method:

  • POST / GET

Parameter:

Parameter name Required Type Explain
api_key_token Yes string Your API key
group_guid Yes integer A group ID
guid Yes integer User GUID who is viewing the group

Example Response

{
    "merchant": "Open Source Social Network",
    "url": "http:\/\/www.mywebsite.com\/",
    "time_token": 1569329343,
    "payload": {
        "group": {
            "guid": "7",
            "owner_guid": "2",
            "description": "New group about",
            "title": "Test Group",
            ...
            ...
            ...
            "ismember": true,
            "request_exists": true,
            "total_requests": false
        }
    },
    "code": "100",
    "message": "Request successfully executed"
}

Return payload parameter description

Parameter name Explain
group.ismember If the viewing user is member of group or not true or false
group.request_exists If user sent request to join group, if group.ismember is true this will be true itself
group.total_requests Total number of member requests

Services View All