Classic APIs
ClassicGroupsApi
groupSearch

groupSearch

Search for groups by keyword.

Parameters

NameTypeDescription
keywordstringThe keyword or phrase to use as the search parameter.
prioritizeExactMatch?booleanWhether or not to prioritize the exact match for the keyword.
limit?10 | 25 | 50 | 100The number of results to be returned.
cursor?stringThe paging cursor for the previous or next page.

Example

const { data: results } = await ClassicGroupsApi.groupSearch({
  keyword: "MightyPart Games",
  prioritizeExactMatch: true,
}); 

Example Data

[
  {
    id: 5850082,
    name: "MightyPart Games",
    description: "Welcome to my amazing group",
    memberCount: 102,
    previousName: "Nameless Game Studio",
    publicEntryAllowed: true,
    created: "2020-03-29T18:15:20.1Z",
    updated: '2023-09-14T06:34:36.243Z',
    hasVerifiedBadge: false,
  },
] 

Endpoint

GET /v1/groups/search