GET
/
2
/
communities
/
search

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

query
string
required

Query to search communities.

Required string length: 1 - 4096
max_results
integer
default:
10

The maximum number of search results to be returned by a request.

Required range: 10 < x < 100
next_token
string

This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

Minimum length: 1
pagination_token
string

This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

Minimum length: 1
community.fields
enum<string>[]

A comma separated list of Community fields to display.

Available options:
access,
created_at,
description,
id,
join_policy,
member_count,
name

Response

200 - application/json
data
object[]
errors
object[]
meta
object