Get arenas - Sqabl APIs

Request

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.

whereUserId

string

optional

If this key exists, only array of arenas where its value, the user ID, is a member of the expected arenas.

whereUserIsOwner

boolean

optional

This depends on the "whereUserId" param; filters out where the user is an owner or not, depending on the boolean value.

whereUserIsMember

boolean

optional

This depends on the "whereUserId" param; filters out where the user is a member or not, depending on the boolean value.

pageSize

integer

optional

For pagination; specifies the maximum number of items to fetch.

lastEvaluatedKey

string

optional

Check the APIs doc on how to use this.

keyword

string

optional

A search query keyword.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.sqabl.com/v1/arenas?checkStateOfThisUserId&whereUserId&whereUserIsOwner&whereUserIsMember&pageSize&lastEvaluatedKey&keyword'

Responses

🟢200Success

application/json

Body

object {0}

Examples

SuccessSuccess (with "checkedThisUserId" param key)

{
    "success": true,
    "statusCode": 200,
    "data": [
        {
            "id": "cm22ydxx6000108mgedm7d313",
            "name": "Arena Name",
            "totalMembers": 14,
            "description": "The arena description",
            "guidelines": "The arena guidelines",
            "coverImageSrc": "https://cover.image.url/",
            "dateCreated": "2024-10-10 07:04:25.227Z"
        },
        {
            "id": "cm22ydxx6000108mgedm7d313",
            "name": "Arena Name",
            "totalMembers": 14,
            "description": "The arena description",
            "guidelines": "The arena guidelines",
            "coverImageSrc": "https://cover.image.url/",
            "dateCreated": "2024-10-10 07:04:25.227Z",
            "deactivated": true
        },
        {
            "id": "cm22ydxx6000108mgedm7d313",
            "name": "Arena Name",
            "totalMembers": 14,
            "description": "The arena description",
            "guidelines": "The arena guidelines",
            "coverImageSrc": "https://cover.image.url/",
            "dateCreated": "2024-10-10 07:04:25.227Z"
        }
    ]
}