@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Clubhouse API
@base https://www.clubhouseapi.com/api/
@version 1
@endpoints 41
@hint download_for_search
@toc start_phone_number_auth(1), call_phone_number_auth(1), resend_phone_number_auth(1), complete_phone_number_auth(1), check_waitlist_status(1), me(1), get_release_notes(1), get_all_topics(1), get_topic(1), get_clubs_for_topic(1), get_profile(1), get_users_for_topic(1), get_channels(1), join_channel(1), leave_channel(1), update_username(1), follow(1), refresh_token(1), get_suggested_invites(1), get_suggested_club_invites(1), get_club(1), check_for_update(1), invite_to_app(1), invite_from_waitlist(1), get_following(1), get_suggested_follows_friends_only(1), get_suggested_follows_all(1), update_notifications(1), get_online_friends(1), get_events(1), get_settings(1), get_welcome_channel(1), record_action_trails(1), get_notifications(1), get_actionable_notifications(1), get_create_channel_targets(1), create_channel(1), get_suggested_speakers(1), search_users(1), get_suggested_follows_similar(1), search_clubs(1)

@group start_phone_number_auth
@endpoint POST /start_phone_number_auth
@returns(200)

@endgroup

@group call_phone_number_auth
@endpoint POST /call_phone_number_auth
@returns(200)

@endgroup

@group resend_phone_number_auth
@endpoint POST /resend_phone_number_auth
@returns(200)

@endgroup

@group complete_phone_number_auth
@endpoint POST /complete_phone_number_auth
@returns(200)

@endgroup

@group check_waitlist_status
@endpoint POST /check_waitlist_status
@returns(200)
@errors {401}

@endgroup

@group me
@endpoint POST /me
@returns(200)
@errors {403}

@endgroup

@group get_release_notes
@endpoint POST /get_release_notes
@returns(200)

@endgroup

@group get_all_topics
@endpoint GET /get_all_topics
@returns(200)

@endgroup

@group get_topic
@endpoint POST /get_topic
@returns(200)

@endgroup

@group get_clubs_for_topic
@endpoint POST /get_clubs_for_topic
@returns(200)

@endgroup

@group get_profile
@endpoint POST /get_profile
@returns(200)

@endgroup

@group get_users_for_topic
@endpoint GET /get_users_for_topic
@optional {topic_id: int, page_size: int, page: int}
@returns(200)

@endgroup

@group get_channels
@endpoint GET /get_channels
@returns(200)

@endgroup

@group join_channel
@endpoint POST /join_channel
@returns(200)
@errors {400}

@endgroup

@group leave_channel
@endpoint POST /leave_channel
@returns(200)

@endgroup

@group update_username
@endpoint POST /update_username
@returns(200)
@errors {400}

@endgroup

@group follow
@endpoint POST /follow
@errors {401}

@endgroup

@group refresh_token
@endpoint POST /refresh_token
@returns(200)
@errors {401}

@endgroup

@group get_suggested_invites
@endpoint POST /get_suggested_invites
@returns(200)

@endgroup

@group get_suggested_club_invites
@endpoint POST /get_suggested_club_invites
@returns(200)

@endgroup

@group get_club
@endpoint POST /get_club
@returns(200)

@endgroup

@group check_for_update
@endpoint GET /check_for_update
@optional {is_testflight: int}
@returns(200)

@endgroup

@group invite_to_app
@endpoint POST /invite_to_app
@errors {400}

@endgroup

@group invite_from_waitlist
@endpoint POST /invite_from_waitlist
@errors {400}

@endgroup

@group get_following
@endpoint POST /get_following
@returns(200)

@endgroup

@group get_suggested_follows_friends_only
@endpoint POST /get_suggested_follows_friends_only
@returns(200)

@endgroup

@group get_suggested_follows_all
@endpoint GET /get_suggested_follows_all
@optional {in_onboarding: bool, page_size: int, page: int}
@returns(200)

@endgroup

@group update_notifications
@endpoint POST /update_notifications
@errors {400}

@endgroup

@group get_online_friends
@endpoint POST /get_online_friends
@returns(200)

@endgroup

@group get_events
@endpoint GET /get_events
@optional {is_filtered: bool, page_size: int, page: int}
@returns(200)

@endgroup

@group get_settings
@endpoint GET /get_settings
@returns(200)

@endgroup

@group get_welcome_channel
@endpoint GET /get_welcome_channel
@returns(200)

@endgroup

@group record_action_trails
@endpoint POST /record_action_trails
@returns(200)

@endgroup

@group get_notifications
@endpoint GET /get_notifications
@optional {page_size: int, page: int}
@returns(200)

@endgroup

@group get_actionable_notifications
@endpoint GET /get_actionable_notifications
@returns(200)

@endgroup

@group get_create_channel_targets
@endpoint POST /get_create_channel_targets
@errors {400}

@endgroup

@group create_channel
@endpoint POST /create_channel
@errors {400}

@endgroup

@group get_suggested_speakers
@endpoint POST /get_suggested_speakers
@returns(200)

@endgroup

@group search_users
@endpoint POST /search_users
@returns(200)

@endgroup

@group get_suggested_follows_similar
@endpoint POST /get_suggested_follows_similar
@returns(200)

@endgroup

@group search_clubs
@endpoint POST /search_clubs
@returns(200)

@endgroup

@end