Groups
The groups
namespace provides API methods to retrieve all or specific user groups. This page covers the following API methods:
GET /groups
/groups
Returns all groups. Requires site admin access.
This method uses pagination so you might need to request additional pages to retrieve all groups.
Request
|
|
|
This method supports the following expands so you can automatically include additional information for referenced objects:
users
Response
Examples
Status codes
200
400
401
403
422
(details)
GET /groups/{group_id}
/groups/{group_id}
Returns a single group. Requires site admin access.
|
Request
|
This method supports the following expands so you can automatically include additional information for referenced objects:
users
Request & response
Examples
Status codes
200
400
401
403
404
422
(details)
Last updated