For the complete documentation index, see llms.txt. This page is also available as Markdown.

Communities V2

List communities (v2, address-only)

get
/v2/communities

Same as GET /v1/communities but the response contains only addresses: the owner address (no owner name) and mutual-friend addresses (string[]) instead of friend profiles. The minimal search branch is unchanged (it already returns no profile information).

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Query parameters
limitintegerOptional
offsetintegerOptional
searchstringOptional
onlyMemberOfbooleanOptional
onlyWithActiveVoiceChatbooleanOptional

Filter to show only communities with active voice chats. Ignored when minimal=true.

minimalbooleanOptional

When true, returns only id, name, membersCount, and privacy for fast lookups. Requires authentication and a search parameter with at least 3 characters. Supports pagination with limit (max 50) and offset. Other filters (onlyMemberOf, onlyWithActiveVoiceChat, roles) are ignored.

Default: false
Responses
200

Communities found

application/json
get/v2/communities

Get community by ID (v2, address-only)

get
/v2/communities/{id}

Same as GET /v1/communities/{id} but the response contains only the owner address (no owner name). Never fails when the owner profile cannot be resolved.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
idstringRequired

The unique identifier of the community.

Responses
200

Community found

application/json
get/v2/communities/{id}

List community members (v2, address-only)

get
/v2/communities/{id}/members

Same as GET /v1/communities/{id}/members but returns the member addresses (and friendship status) only, without any profile information. Members whose profile is missing are NOT dropped.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
idstringRequired

The unique identifier of the community.

Query parameters
limitintegerOptional
offsetintegerOptional
onlyOnlinebooleanOptional
Responses
200

Members found

application/json
get/v2/communities/{id}/members

List banned members (v2, address-only)

get
/v2/communities/{id}/bans

Same as GET /v1/communities/{id}/bans but returns the banned member addresses (and friendship status) only, without any profile information.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
idstringRequired

The unique identifier of the community.

Query parameters
limitintegerOptional
offsetintegerOptional
Responses
200

Banned members found

application/json
get/v2/communities/{id}/bans

Get community requests (v2, address-only)

get
/v2/communities/{id}/requests

Same as GET /v1/communities/{id}/requests but returns the requesting member addresses (and friendship status) only, without any profile information.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
idstringRequired

The unique identifier of the community.

Query parameters
typestring · enumOptionalPossible values:
limitintegerOptional
offsetintegerOptional
Responses
200

Community requests found

application/json
get/v2/communities/{id}/requests

Get member requests (v2, address-only)

get
/v2/members/{address}/requests

Same as GET /v1/members/{address}/requests but each request's community carries the owner address (no owner name) and mutual-friend addresses (string[]).

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
addressstringRequired

The address of the member.

Query parameters
typestring · enumOptionalPossible values:
limitintegerOptional
offsetintegerOptional
Responses
200

Member requests found

application/json
get/v2/members/{address}/requests

Get community posts (v2, address-only)

get
/v2/communities/{id}/posts

Same as GET /v1/communities/{id}/posts but returns the post author addresses only, without any profile information.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
idstringRequired

The unique identifier of the community.

Query parameters
limitintegerOptional
offsetintegerOptional
Responses
200

Posts found

application/json
get/v2/communities/{id}/posts

Last updated