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

Updated Thu Sep 22nd 2022, 19:00 UTC

Get

GET /:account/group_filters/:group_filter{?q}

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.

This endpoint is also capable of searching across group names.

Examples

Getting the show

Request

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

Response

Status

200

Response Type

GroupFilter

Example Body

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

Searching for a group

Request

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

Response

Status

200

Response Type

GroupFilter

Example Body

{
  "@type": "GroupFilter",
  "@context": "/contexts/GroupFilter.jsonld",
  "id": "/my_account/group_filters/accounts",
  "slug": "accounts",
  "title": "Account Groups",
  "groups": "/my_account/group_filters/accounts/groups?q=Target"
}

© 2022 TextUs