Skip to main content
GET
/
v1
/
community
/
points
/
{pointSystemId}
/
balance
cURL
curl --request GET \
  --url https://api.flipsuite.xyz/v1/community/points/{pointSystemId}/balance \
  --header 'x-api-key: <x-api-key>'
{
  "data": [
    {
      "platform": "discord",
      "userId": "328218133074804739",
      "balance": 100
    }
  ],
  "pagination": {
    "offset": 123,
    "limit": 123,
    "total": 123,
    "count": 123
  }
}

Headers

x-api-key
string
required

Your community API key

Path Parameters

pointSystemId
string
required

ID of a point system

Query Parameters

platform
string
default:discord

Platform to get balances for

Allowed value: "discord"
userIds
string[]

Specific user IDs to get balances for

offset
number
default:0
Required range: x >= 0
limit
number
default:20
Required range: 0 <= x <= 100
sortBy
enum<string>
default:balance-desc

Sort direction

Available options:
balance-desc,
balance-asc

Response

200 - application/json

Balances have been retrieved

data
object[]
required

Point system balances

pagination
object
required

Pagination metadata