Skip to main content

ListSuggestedGroups​

Returns a list of suggested groups.

Query Parameters
  • watch_index string

    A query parameter denoting the requests watch index.

Responses

ListSuggestedGroups 200 response

Schema
  • groups object[] required

    A list of group summaries.

    • group_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • display_name string required

      Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

      Represent a resource's readable display name.

    • avatar_url string

      The URL of this group's avatar image.

    • external object required

      External links for this group.

      • profile string required

        A link to this group's profile page.

      • chat string required

        A link to this group's chat page.

    • is_developer boolean required

      Whether or not this group is a developer.

    • bio string required

      Possible values: 1 ≤ length ≤ 200, Value must match regular expression ^[^\r]+$

      Detailed information about a profile.

    • is_current_identity_member boolean required

      Whether or not the current identity is a member of this group.

    • publicity string required

      Possible values: [open, closed]

      The current publicity value for the given group.

    • member_count int32 required

      Unsigned 32 bit integer.

  • watch object required

    Provided by watchable endpoints used in blocking loops.

    • index string required

      Index indicating the version of the data responded.

      Pas this to rivet.common#WatchQuery to block and wait for the next response.