Groups

Note

This is a read-only resource. You cannot create or edit groups.

Groups define the permissions user’s have in your system.

Property Type Description
id int Unique identifier
name string Name of the group
description string Short description of the permissions available to the user

List Groups

GET /groups.json

Returns all groups.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

  [
    {
      "id": 1,
      "name": "Administrator",
      "description": "Full system access"
    }
  ]

Retrieve a Group

GET /groups/[id].json

Returns a single group by its id.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

    {
      "id": 1,
      "name": "Administrator",
      "description": "Full system access"
    }