Passer au contenu principal
GET
/
2
/
communities
/
search
Rechercher des communautés
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>"
  }
}

Autorisations

​
Authorization
string
header
requis

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

Paramètres de requête

​
query
string
requis

Requête de recherche de communautés.

Required string length: 1 - 4096
Exemple:

"Love"

​
max_results
integer<int32>
défaut:10

Nombre maximal de résultats qu’une requête de recherche peut renvoyer.

Plage requise: 10 <= x <= 100
​
next_token
string

Ce paramètre permet d’obtenir 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. Jeton suivant.

Minimum string length: 1
​
pagination_token
string

Ce paramètre est utilisé pour obtenir la page suivante de résultats. 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. Jeton suivant.

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

Une liste de champs de Communauté à afficher, séparés par des virgules. Les champs disponibles pour l’objet Community.

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

Réponse

La requête a réussi.

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

Un objet HTTP Problem Details, tel que défini dans la RFC IETF 7807 (https://tools.ietf.org/html/rfc7807).

​
meta
object