GET
/
2
/
spaces
/
search

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string
required

The search query.

Required string length: 1 - 2048
state
enum<string>
default: all

The state of Spaces to search for.

Available options:
live,
scheduled,
all
max_results
integer
default: 100

The number of results to return.

Required range: 1 < x < 100
space.fields
enum<string>[]

A comma separated list of Space fields to display.

Available options:
created_at,
creator_id,
ended_at,
host_ids,
id,
invited_user_ids,
is_ticketed,
lang,
participant_count,
scheduled_start,
speaker_ids,
started_at,
state,
subscriber_count,
title,
topic_ids,
updated_at
expansions
enum<string>[]

A comma separated list of fields to expand.

Available options:
creator_id,
host_ids,
invited_user_ids,
speaker_ids,
topic_ids
user.fields
enum<string>[]

A comma separated list of User fields to display.

Available options:
affiliation,
connection_status,
created_at,
description,
entities,
id,
location,
most_recent_tweet_id,
name,
pinned_tweet_id,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscription_type,
url,
username,
verified,
verified_type,
withheld
topic.fields
enum<string>[]

A comma separated list of Topic fields to display.

Available options:
description,
id,
name

Response

200 - application/json
data
object[]
errors
object[]
includes
object
meta
object