Get post participants

Request

Path Params

id

string

required

Query Params

optionIndex

integer

optional

For polls; if supplied, an array of participants only is returned for that index; otherwise, participants from all indexes are returned.

argumentType

enum<string>

optional

For debates; if supplied, only an array of participants, in accordance with the supplied type, is returned.

Allowed values:

supportoppose

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

Search query

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/post//participants?optionIndex&argumentType&pageSize&lastEvaluatedKey&keyword'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "success": true,
    "statusCode": 200,
    "data": [
        {
            "id": "cm1n5ubk200008ov3f8907ugy",
            "displayName": "Hiseous Zaddy",
            "imageSrc": "https://image.url/"
        },
        {
            "id": "cm1n5ubk200008ov3f8907ugy",
            "displayName": "Hiseous Zaddy",
            "imageSrc": "https://image.url/",
            "description": "My description"
        },
        {
            "id": "cm1n5ubk200008ov3f8907ugy",
            "displayName": "Hiseous Zaddy",
            "imageSrc": "https://image.url/",
            "description": "My description"
        }
    ]
}