Groups

Users can be part of zero or multiple groups.

Create a group

URL

POST /groups HTTP/1.1

Input

Name	Type	Description
id	string	Optional A unique identifier. If none is given, one is generated.
name	string	Required The name of the group.
categories	string[]	Optional A list of ids of categories that are assigned to the group.

Request

POST /groups HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "id": "GROUP_1",
  "name": "First Grade",
  "categories": ["5066549580791808"]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "GROUP_1",
  "name": "First Grade",
  "categories": ["5066549580791808"]
}

List groups

URL

GET /groups HTTP/1.1

Request

GET /groups HTTP/1.1
Accept: application/json

Response

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

[
  {
    "id": "GROUP_1",
    "name": "First Grade",
    "categories": ["5066549580791808"]
  },
  {
    "id": "GROUP_2",
    "name": "Second Grade",
    "categories": ["9738482397896533"]
  }
]

Get a single group

URL

GET /groups/:group HTTP/1.1

• group - Required The identifier of the group.

Request

GET /groups/GROUP_1 HTTP/1.1
Accept: application/json

Response

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

{
  "id": "GROUP_1",
  "name": "First Grade",
  "categories": ["5066549580791808"]
}