Sqabl APIs

Get arena

Prod Env

https://api.sqabl.com/v1

GET

/arena/{id}

Request

Path Params

string

required

Query Params

checkStateOfThisUserId

string

optional

Provide a user id, to check their state in the arena, such as if they are a member or a moderator of an arena.
This does not change the number of arenas to be fetched, it only attaches queriedUser's states within each arena gotten.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "success": true,
    "statusCode": 200,
    "data": {
        "id": "cm1ngo6io0000qwv3am7h3ij4",
        "name": "Hiseous Umbrella",
        "description": "The arena description",
        "guidelines": "The arena guidelines",
        "coverImageSrc": "https://cover.image.url/",
        "dateCreated": "2024-09-29 11:51:58",
        "owner": {
            "id": "cm1n5ubk200008ov3f8907ugy",
            "displayName": "Hiseous Hiseous",
            "imageSrc": "https://image.url/"
        },
        "totalMembers": 3
    }
}

Arena

Update arena