ASI/groups/@public

GET ^top

Returns all the groups visible in the current session.

Parameters

sort_order

Possible values are ascending and descending. Defaults to descending.

sort_by

Field to sort results by. Defaults to updated_at. Possible values are created_at, updated_at, title, description, creator.

page

Page to display.

per_page

Number of entries to display.

query

A query to limit the group listing (optional). If this parameter is present, only groups whose title or description match the query are returned. The returned groups are sorted by relevance. Hidden groups that the possible logged-in user is a member of are present in the list.

Access

Application

Returns

  • 200 - OK

Response example


{
  "entry": [
    {
      "number_of_members": 0,
      "created_at": null,
      "title": "An example group 4",
      "group_type": "open",
      "id": "avlDre6Cqr4lFdeJfcaj6R",
      "created_by": "avlEiS6Cqr4lFdeJfcaj6R",
      "description": "Groups can have descriptions. This is an example."
    },
    {
      "number_of_members": 0,
      "created_at": null,
      "title": "An example group 5",
      "group_type": "open",
      "id": "avmtSG6Cqr4lFdeJfcaj6R",
      "created_by": "avmuFW6Cqr4lFdeJfcaj6R",
      "description": "Groups can have descriptions. This is an example."
    },
    {
      "number_of_members": 0,
      "created_at": null,
      "title": "An example group 6",
      "group_type": "open",
      "id": "avnhIu6Cqr4lFdeJfcaj6R",
      "created_by": "avniwc6Cqr4lFdeJfcaj6R",
      "description": "Groups can have descriptions. This is an example."
    }
  ]
}

SUBRESOURCES ^top