Skip to main content

CommunitiesClient

Class Bases: object Client for communities operations

Constructors

__init__

Parameters

Client

get_by_id

Get Community by ID Retrieves details of a specific Community by its ID.

Parameters

Any
The ID of the Community.
List or None
default:"None"
A comma separated list of Community fields to display.

Returns

GetByIdResponse - Response data Search Communities Retrieves a list of Communities matching the specified search query.

Parameters

str
Query to search communities.
int or None
default:"None"
The maximum number of search results to be returned by a request.
Any or None
default:"None"
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.
Any or None
default:"None"
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.
List or None
default:"None"
A comma separated list of Community fields to display.

Returns

IteratorSearchResponse