getUserGroups
- Home
- Users & Groups
- SvcGroups
- getUserGroups
getUserGroups
Gets the groups a user is a member of.
Parameters
| Name | Description |
| userID required | ID of the user performing the action. |
| tierID optional | |
| status optional | Group membership status type for a user. |
| page optional | Page of results to return. |
| perPage optional | Number of items to return per page. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/svcGroups?action=getUserGroups&userID=229829209&devkey=[devkey] |
JSON Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
{ "service":"svcGroups", "action":"getUserGroups", "item":[ { "group_id":"1000811", "display_name":"developers", "group_name":"developers", "desc_full":"An API test group.", "desc_small":"Developers", "date_added":"1547860875", "domain":"onesitedemo.com", "subdir":"developers", "group_url":"http://www.onesitedemo.com/developers", "join_method":"group_suspended", "group_access":"public", "member_content_association":"screen", "avatar":"http://services.onesite.com/resources/images/group-default-avatar.jpg?ver=13.06.21", "photo":"http://services.onesite.com/resources/images/unisex_v4.gif?ver=13.06.21", "num_members":"1", "owner_id":"229928503", "blog_id":"234714453", "date_updated":"2019-01-30 14:13:58", "category_name":"Test 1", "category_id":"16561", "user_status":"moderator" } ], "code":1, "message":"User Groups Successfully Retrieved", "total":"1", "page":1, "per_page":10 } |
Service Information
| Service | svcGroups |
| Method | getUserGroups |
| Type | REST |
| Response Types | JSON, XML |