Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:29 UTC

Get a Group Filter

GET /:account/group_filters/:group_filter

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 single group filter.

Examples

Getting the group filter

Request

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

Response

Status

200

Response Type

GroupFilter

Example
{
  "@type": "GroupFilter",
  "@context": "/contexts/GroupFilter.jsonld",
  "id": "/my_account/group_filters/mine",
  "slug": "mine",
  "title": "My Groups",
  "groups": "/my_account/group_filters/mine/groups"
}

© 2021 TextUs