Skip to main content
GET
cURL

Headers

x-api-key
string
required

Your community API key

Query Parameters

query
string

Search query to match point system name against

Maximum string length: 256
statuses
enum<string>[]

Point system statuses to filter by

Available options:
ACTIVE,
ARCHIVED,
SUSPENDED
permission
enum<string>
default:VIEW

Required permission for returned point systems

Available options:
VIEW,
TRANSFER,
SPEND,
PRINT
includeShared
boolean
default:false

Whether to include shared point systems available through collabs

offset
number
default:0
Required range: x >= 0
limit
number
default:20
Required range: 0 <= x <= 50

Response

200 - application/json

Point systems have been retrieved

data
object[]
required

Point systems matching the query

pagination
object
required

Pagination metadata