Saltar al contenido principal
GET
/
2
/
communities
/
search
Buscar comunidades
curl --request GET \
  --url https://api.x.com/2/communities/search \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1146654567674912769",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "next_token": "<string>"
  }
}

Autorizaciones

Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de consulta

query
string
requerido

Consulta de búsqueda para Communities.

Required string length: 1 - 4096
Ejemplo:

"Love"

max_results
integer<int32>
predeterminado:10

Número máximo de resultados de búsqueda que puede devolver una solicitud.

Rango requerido: 10 <= x <= 100
next_token
string

Este parámetro se utiliza para obtener la siguiente «página» de resultados. El valor utilizado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse. Token siguiente.

Minimum string length: 1
pagination_token
string

Este parámetro se utiliza para obtener la siguiente «página» de resultados. El valor que se pasa en el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar. Token siguiente.

Minimum string length: 1
community.fields
enum<string>[]

Una lista de campos de Comunidades, separados por comas, que se deben mostrar. Campos disponibles para un objeto Community.

Minimum array length: 1
Opciones disponibles:
access,
created_at,
description,
id,
join_policy,
member_count,
name
Ejemplo:
[
"access",
"created_at",
"description",
"id",
"join_policy",
"member_count",
"name"
]

Respuesta

La solicitud se ha completado correctamente.

data
object[]
Minimum array length: 1
errors
object[]
Minimum array length: 1

Un objeto HTTP Problem Details, tal como se define en el IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

meta
object