GET /api/v2/collections/:collection_id/user_groups
Get user groups

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Examples

// Successful request
GET /api/v2/collections/iJjOBm6uWo26MGKijlLS/user_groups
200
{
  "user_groups": [
    {
      "id": 1,
      "name": "user-group-1",
      "description": "Sample user group for tests",
      "created_at": "2023-11-27T09:42:43.662Z",
      "updated_at": "2023-11-27T09:42:43.662Z",
      "users": []
    }
  ]
}
// If :collection_id is not found
GET /api/v2/collections/not-found-id/user_groups
404
{
  "error": "collection not found"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters