Skip to main content
GET
/
groups
/
search
/
{search}
Search groups
curl --request GET \
  --url https://api.example.com/groups/search/{search}
import requests

url = "https://api.example.com/groups/search/{search}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/groups/search/{search}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/groups/search/{search}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/groups/search/{search}"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/groups/search/{search}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/groups/search/{search}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": 1,
      "content_type": "group",
      "name": "Team Alpha",
      "description": "<string>",
      "type": "public",
      "mute_rule": 123,
      "has_unread_notifications": true,
      "only_admin_publish": 123,
      "post_comments_enabled_default": true,
      "member": "<string>",
      "image": {},
      "auto": {},
      "url": "api/groups/1",
      "permissions": {
        "member": "<string>",
        "edit": true,
        "delete": true
      },
      "publish": {
        "updated_at": 123
      },
      "membership": {
        "auto": true
      },
      "stats": {
        "active": 123
      }
    }
  ]
}

Path Parameters

Search string to match against group names

Query Parameters

mode
enum<string>

Filter groups by membership mode. member lists groups the user is a member of, available lists joinable public groups, and can_publish lists groups where the user is allowed to publish.

Available options:
member,
available,
can_publish
limit
integer

Maximum number of groups per page (1–100). Defaults to 50.

Required range: 1 <= x <= 100

Response

200 - application/json

Search results with matching groups.

data
object[]