Skip to main content Link Search Menu Expand Document (external link)

Updated Thu Sep 22nd 2022, 19:00 UTC

Group Filters

GET /:account/group_filters

Note: This endpoint is still under active development, and may change without warning.

A GroupFilter is a pre-made search for groups in various folders. All users will have two initial folders with titles “My Groups” and “Account Groups”. Together, these filters serve as an initial index of group folders. Groups that are created by the current user will appear in the “My Groups” folder, while groups that were created with an account associated by membership to the current user will appear in the “Account Groups” folder.

The response of this endpoint represents a collection of GroupFilter items.

Examples

Getting the index

Request

GET /my_account/group_filters
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/group_filters
    

Response

Status

200

Response Type

hydra:Collection

Example Body

{
  "@type": "hydra:Collection",
  "id": "/my_account/group_filters",
  "@context": "/contexts/hydra:Collection.jsonld",
  "totalItems": 2,
  "members": [
    {
      "@type": "GroupFilter",
      "@context": "/contexts/GroupFilter.jsonld",
      "id": "/my_account/group_filters/mine",
      "slug": "mine",
      "title": "My Groups",
      "groups": "/my_account/group_filters/mine/groups"
    }
  ]
}

Table of contents


© 2022 TextUs