API Reference

V1

Circles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Circle profile and summary stats

client.v1.circles.retrieve(stringid, RequestOptionsoptions?): CircleRetrieveResponse { id, createdAt, description, 9 more }

GET/api/v1/circles/{id}

Returns the circle's profile and aggregate counts (members, quests, posts).

The caller must be a member of the circle, or use a circle API key scoped to it.

ParametersExpand Collapse

id: string

ReturnsExpand Collapse

CircleRetrieveResponse { id, createdAt, description, 9 more }

id?: string

createdAt?: string

formatdate-time

description?: string | null

discordUrl?: string | null

emoji?: string | null

isPrivate?: boolean

memberCount?: number

name?: string

ownerId?: string

postCount?: number

questCount?: number

xUrl?: string | null

Circle profile and summary stats

TypeScript

HTTP

TypeScript

import Racks from 'racks.cash';

const client = new Racks();

const circle = await client.v1.circles.retrieve('clxxxxxxxxxxxxxxxxxxxxxxxx');

console.log(circle.id);

200 example

{
  "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "discordUrl": "https://discord.gg/abc",
  "emoji": "🔥",
  "isPrivate": true,
  "memberCount": 42,
  "name": "Degen Questers",
  "ownerId": "ownerId",
  "postCount": 300,
  "questCount": 7,
  "xUrl": "https://x.com/degenraiders"
}

Returns Examples

200 example

{
  "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "discordUrl": "https://discord.gg/abc",
  "emoji": "🔥",
  "isPrivate": true,
  "memberCount": 42,
  "name": "Degen Questers",
  "ownerId": "ownerId",
  "postCount": 300,
  "questCount": 7,
  "xUrl": "https://x.com/degenraiders"
}