User Badge Data

GET /api/v1/badging/user/badge/data

GET /api/v1/badging/user/badge/data

cURL

curl --request GET \
  --url https://api.scoot.app/api/v1/badging/user/badge/data \
  --header 'X-API-Key: <api-key>'

200

[
  {
    "title": "<string>",
    "value": "<string>",
    "multiValues": [
      "<string>"
    ],
    "options": [
      "<string>"
    ],
    "description": "<string>",
    "required": true,
    "featured": true
  }
]

Gets user badge data.

Authorizations

X-API-Key · string · header · required

Query Parameters

socialRoomSetId · string<uuid> · required

page · integer · default: 0

Page number to get, used with pageSize

size · integer · default: 20

Number of items to get in one request, used with page

sort · string

Property to sort by. Append ',' and directions 'asc/desc' to change direction

Response

200 - application/json

OK

title · string

value · string

multiValues · string[]

options · string[]

description · string

required · boolean

featured · boolean

visibility · enum<string>

Available options: ALL, ACCOUNT_USERS, HOSTS, INTERNAL

inputType · enum<string>

Available options: TEXT, PARAGRAPH, SINGLE_SELECT, MULTI_SELECT, NUMBER