Skip to content

getPublicShare

GET
/public/shares/{token}
curl --request GET \
  --url http://localhost:8080/api/v1/public/shares/example

CORS-enabled. Returns the circle pack. Increments view count.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
string
>= 20 characters <= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Circle pack.

Media typeapplication/json

Portable circle format. Also saved as .homestead.json files.

object
format
required
string
Allowed value: homestead.circle-pack
version
required
integer
Allowed value: 1
circle
required
object
name
required
string
icon
required
string
color
required
string
Allowed values: terracotta honey sage dusk plum clay
sharedBy
object
householdName
string
memberName
string
people
required
Array<object>
<= 1000 items
object
ref
required

Opaque per-pack reference.

string
displayName
required
string
relationLabel
string
kind
required
string
Allowed values: family friend creator other
notes
string
avatarUrl
string format: uri
accounts
required
Array<object>
object
platform
required
string
Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial
handle
required
string
platformUserId
string
profileUrl
required
string format: uri
createdAt
required
string format: date-time
expiresAt
One of:
string format: date-time

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "circle": {
    "color": "terracotta",
    "icon": "home",
    "name": "Family"
  },
  "createdAt": "2026-10-15T09:00:00.000Z",
  "expiresAt": "2026-11-16T09:00:00.000Z",
  "format": "homestead.circle-pack",
  "people": [
    {
      "accounts": [
        {
          "handle": "mom.wong.bkk",
          "platform": "instagram",
          "profileUrl": "https://www.instagram.com/mom.wong.bkk/"
        },
        {
          "handle": "pranee.wong",
          "platform": "facebook",
          "profileUrl": "https://www.facebook.com/pranee.wong"
        }
      ],
      "displayName": "Mom",
      "kind": "family",
      "ref": "p1",
      "relationLabel": "แม่"
    },
    {
      "accounts": [
        {
          "handle": "lin.cooks",
          "platform": "instagram",
          "profileUrl": "https://www.instagram.com/lin.cooks/"
        }
      ],
      "displayName": "Lin",
      "kind": "family",
      "ref": "p2",
      "relationLabel": "Cousin"
    },
    {
      "accounts": [
        {
          "handle": "~grandma_noi",
          "platform": "line",
          "profileUrl": "https://line.me/R/ti/p/~grandma_noi"
        }
      ],
      "displayName": "Grandma Noi",
      "kind": "family",
      "ref": "p3",
      "relationLabel": "ยาย"
    },
    {
      "accounts": [
        {
          "handle": "wei_chengdu88",
          "platform": "wechat",
          "profileUrl": "https://weixin.qq.com/"
        },
        {
          "handle": "MS4wLjABAAAAweichengdu0000000000000000000000",
          "platform": "douyin",
          "platformUserId": "98765432101",
          "profileUrl": "https://www.douyin.com/user/MS4wLjABAAAAweichengdu0000000000000000000000"
        }
      ],
      "displayName": "Uncle Wei",
      "kind": "family",
      "ref": "p4",
      "relationLabel": "舅舅"
    }
  ],
  "sharedBy": {
    "householdName": "The Wongs' Homestead",
    "memberName": "Mali"
  },
  "version": 1
}

404

Section titled “404”

Not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}

410

Section titled “410”

Expired or revoked.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}

429

Section titled “429”

Too many requests. See Retry-After.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer