Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.2 KB

universe-join-user-user_id.md

File metadata and controls

40 lines (31 loc) · 1.2 KB

/{universe}/join/user/{user_id}

Information

GET https://api.brickverse.co/v2/worlds/{universe_id}/join/user/user_id

User must have Public Joins enabled or must be friends.

Query Parameters

Name Type Description
launch_client Bool Launch brickverse client or not.
return_url String Redirect a user after launching the client. launch_client query param is required.

{% tabs %} {% tab title="200: OK Response" %}

{"status": "ok", "success": true, "client_join_token": "XXXXXXXXXXXXXXX"}

{% endtab %}

{% tab title="403: Forbidden " %}

{"status": "error", "message": 403}

{% endtab %}

{% tab title="429: Too Many Requests " %}

{"status": "error", "message": "Rate limited", "ratelimited": true, "time": "seconds_string"}

{% endtab %}

{% tab title="400: Bad Request " %}

{"status": "error", "message": "reason_string"}

{% endtab %} {% endtabs %}