> ## 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">
  ## Submódulos
</div>

* [Módulo xdk.communities.client](/es/xdks/python/reference/xdk.communities.client)
  * [`CommunitiesClient`](/es/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient)
    * [`CommunitiesClient.__init__()`](/es/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.__init__)
    * [`CommunitiesClient.get_by_id()`](/es/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.get_by_id)
    * [`CommunitiesClient.search()`](/es/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.search)
* [Módulo xdk.communities.models](/es/xdks/python/reference/xdk.communities.models)
  * [`GetByIdResponse`](/es/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse)
    * [`GetByIdResponse.model_config`](/es/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse.model_config)
  * [`SearchResponse`](/es/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse)
    * [`SearchResponse.model_config`](/es/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse.model_config)

<div id="module-contents">
  ## Contenido del módulo
</div>

Este módulo proporciona acceso a los endpoints de comunidades de la X API
y sirve como punto de entrada principal para todas las funciones relacionadas con comunidades.

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

Client para operaciones relacionadas con comunidades

<div id="parameters">
  #### Parámetros
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

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

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

Obtener Community por id
Obtiene los detalles de una Community específica por su id.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.id" type="Any">
  El identificador de la Comunidad.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  Una lista de campos de Comunidad separados por comas para mostrar.
</ParamField>

#### Devuelve

`GetByIdResponse` - Datos de respuesta

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

Buscar comunidades
Obtiene una lista de comunidades que coinciden con la consulta de búsqueda especificada.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.query" type="str">
  Consulta para buscar comunidades.
</ParamField>

<ParamField path="path.max_results" type="int or None" default="None">
  La cantidad máxima de resultados de búsqueda que se devolverán en una solicitud.
</ParamField>

<ParamField path="path.next_token" type="Any or None" default="None">
  Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
</ParamField>

<ParamField path="path.pagination_token" type="Any or None" default="None">
  Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  Una lista separada por comas de campos de Comunidad que se mostrarán.
</ParamField>

<div id="returns">
  #### Valores de retorno
</div>

`IteratorSearchResponse`
