Skip to content
racks
Get started
API Reference
V1

Circles

Circle-scoped data (members, quests, leaderboard)

Circle profile and summary stats
GET/api/v1/circles/{id}
Members of a circle
GET/api/v1/circles/{id}/members
XP leaderboard for a circle
GET/api/v1/circles/{id}/leaderboard

CirclesQuests

Circle-scoped data (members, quests, leaderboard)

Quests for a circle
GET/api/v1/circles/{id}/quests
Create a quest in a circle
POST/api/v1/circles/{id}/quests
ModelsExpand Collapse
Quest = object { id, createdAt, deadline, 6 more }
id: optional string
createdAt: optional string
formatdate-time
deadline: optional string
formatdate-time
description: optional string
rewardPoolCents: optional number

Total reward pool in cents

status: optional "ACTIVE" or "ENDED" or "CANCELLED"
One of the following:
"ACTIVE"
"ENDED"
"CANCELLED"
submissionCount: optional number
targetUrl: optional string
title: optional string

CirclesPosts

Circle-scoped data (members, quests, leaderboard)

Recent posts in a circle
GET/api/v1/circles/{id}/posts
Create a post in a circle
POST/api/v1/circles/{id}/posts
ModelsExpand Collapse
Post = object { id, author, content, 3 more }
id: optional string
author: optional object { id, image, name, username }
id: optional string
image: optional string
name: optional string
username: optional string
content: optional string
createdAt: optional string
formatdate-time
mediaType: optional "TEXT" or "IMAGE" or "VIDEO"
One of the following:
"TEXT"
"IMAGE"
"VIDEO"
mediaUrl: optional string

CirclesSocial

Social account connections and cross-posting via Zernio

Connected social accounts for a circle
GET/api/v1/circles/{id}/social/accounts
Publish to connected social accounts
POST/api/v1/circles/{id}/social/publish