Skip to content
racks
Get started
API Reference
V1
Circles

Members of a circle

GET/api/v1/circles/{id}/members

Returns the circle member list with username, role, XP, level, and join date. Ordered by role (owner first) then join date.

Path ParametersExpand Collapse
id: string
Query ParametersExpand Collapse
limit: optional number

Max results (1–100, default 50)

minimum1
maximum100
offset: optional number

Pagination offset (default 0)

minimum0
ReturnsExpand Collapse
members: optional array of object { id, image, joinedAt, 6 more }
id: optional string
image: optional string
joinedAt: optional string
formatdate-time
level: optional number
name: optional string
role: optional "OWNER" or "ADMIN" or "MEMBER"
One of the following:
"OWNER"
"ADMIN"
"MEMBER"
streakDays: optional number
username: optional string
xp: optional number

Members of a circle

curl https://racks.cash/api/v1/circles/$ID/members
{
  "limit": 0,
  "offset": 0,
  "total": 0,
  "members": [
    {
      "id": "id",
      "image": "image",
      "joinedAt": "2019-12-27T18:11:19.117Z",
      "level": 0,
      "name": "name",
      "role": "OWNER",
      "streakDays": 0,
      "username": "username",
      "xp": 0
    }
  ]
}
Returns Examples
{
  "limit": 0,
  "offset": 0,
  "total": 0,
  "members": [
    {
      "id": "id",
      "image": "image",
      "joinedAt": "2019-12-27T18:11:19.117Z",
      "level": 0,
      "name": "name",
      "role": "OWNER",
      "streakDays": 0,
      "username": "username",
      "xp": 0
    }
  ]
}