> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CommunitiesClient

<div id="submodules">
  ## Sous-modules
</div>

* [module xdk.communities.client](/fr/xdks/python/reference/xdk.communities.client)
  * [`CommunitiesClient`](/fr/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient)
    * [`CommunitiesClient.__init__()`](/fr/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.__init__)
    * [`CommunitiesClient.get_by_id()`](/fr/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.get_by_id)
    * [`CommunitiesClient.search()`](/fr/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.search)
* [module xdk.communities.models](/fr/xdks/python/reference/xdk.communities.models)
  * [`GetByIdResponse`](/fr/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse)
    * [`GetByIdResponse.model_config`](/fr/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse.model_config)
  * [`SearchResponse`](/fr/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse)
    * [`SearchResponse.model_config`](/fr/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse.model_config)

<div id="module-contents">
  ## Contenu du module
</div>

Ce module permet d'accéder aux endpoints des communautés de la X API
et sert de point d'entrée principal pour toutes les fonctionnalités liées aux communautés.

<div id="class-xdkcommunitiescommunitiesclient">
  ### `class xdk.communities.CommunitiesClient`
</div>

Client pour les opérations relatives aux communautés

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.client" type="Client" />

<div id="__init__">
  ### `__init__`
</div>

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.client" type="Client" />

<div id="get_by_id">
  ### `get_by_id`
</div>

Récupérer une Community par id
Récupère les détails d'une Community spécifique à partir de son id.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.id" type="Any">
  L'identifiant de la Communauté.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  Liste de champs de Communauté, séparés par des virgules, à afficher.
</ParamField>

<div id="returns">
  #### Renvoie
</div>

`GetByIdResponse` - Données de réponse

<div id="search">
  ### `search`
</div>

Rechercher des communautés
Renvoie une liste de communautés correspondant à la requête de recherche spécifiée.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.query" type="str">
  Requête pour rechercher des communautés.
</ParamField>

<ParamField path="path.max_results" type="int or None" default="None">
  Nombre maximal de résultats de recherche à renvoyer dans une requête.
</ParamField>

<ParamField path="path.next_token" type="Any or None" default="None">
  Ce paramètre est utilisé pour récupérer la « page » de résultats suivante. La valeur utilisée avec ce paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
</ParamField>

<ParamField path="path.pagination_token" type="Any or None" default="None">
  Ce paramètre est utilisé pour récupérer la « page » de résultats suivante. La valeur utilisée avec ce paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  Liste de champs Community à afficher, séparés par des virgules.
</ParamField>

<div id="returns">
  #### Renvoie
</div>

`IteratorSearchResponse`