Group Detail
- Endpoint Path:
/api/v2/group/{gid}/detail
- Method:
GET
- Request:
Rest
Headers Optional Parameter
Parameter Name | Public Mode (Required) | Private Mode (Required) |
---|---|---|
X-Fresns-Aid | optional | required |
X-Fresns-Aid-Token | optional | required |
X-Fresns-Uid | optional | required |
X-Fresns-Uid-Token | optional | required |
Rest Params
Parameter Name | Type | Required | Description |
---|---|---|---|
gid | String | required | Group GID |
Query Params
Parameter Name | Type | Required | Description |
---|---|---|---|
whitelistKeys | String | optional | Whitelist key names, only returns key-value pairs for the given key names Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
blacklistKeys | String | optional | Blacklist key names, removes specified key-value pairs from the returned data Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
Return
json
{
"code": 0,
"message": "ok",
"data": {
"items": {
"title": "String / SEO Title",
"keywords": "String / SEO Keywords",
"description": "String / SEO Description",
"extensions": [
{
// Group Extensions
// Common Data Structure -> Extend Function Info
}
]
},
"detail": {
// Common Data Structure -> Group Info
}
}
}