Skip to main content

SearchGroups​

Fuzzy search for groups.

Query Parameters
  • query string required

    The query to match group display names against.

  • anchor string

    How many groups to offset the search by.

  • limit int32

    Possible values: 1 ≤ value ≤ 32

    Amount of groups to return.

Responses

SearchGroups 200 response

Schema
  • groups object[] required

    A list of group handles.

    • 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

      Whether or not this group is a developer group.