Skip to main content

​
Submodules

​
Module contents

This module provides access to the communities endpoints of the X API and serves as the main entry point for all communities-related functionality.

​
class xdk.communities.CommunitiesClient

Client for communities operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
get_by_id

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

​
Parameters

​
path.id
Any
The ID of the Community.
​
path.community_fields
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

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

​
Returns

SearchResponse - Response data