listShares

GET

/circles/{circleId}/shares

const url = 'http://localhost:8080/api/v1/circles/per_01j9x3k8m2q4r5s6t7v8w9y0z1/shares';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/circles/per_01j9x3k8m2q4r5s6t7v8w9y0z1/shares \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

circleId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

Responses

200

Share links for the circle.

application/json

object

items

required

Array<object>

object

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

circleId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

tokenPrefix

required

string

url

Only on create.

string format: uri

qrPayload

Only on create. Same as url.

string

includeNotes

required

boolean

includeRelationLabels

required

boolean

expiresAt

One of:

string
null

string format: date-time

revokedAt

One of:

string
null

string format: date-time

viewCount

required

integer

importCount

required

integer

createdAt

required

string format: date-time

Examples

seed

Derived from fixtures/seed.json.

{
  "items": [
    {
      "circleId": "cir_01j9kaptqa5dcqne4nmnrbp86d",
      "createdAt": "2026-10-15T09:00:00.000Z",
      "expiresAt": "2026-11-16T09:00:00.000Z",
      "id": "shr_01j9a1b2c3d4e5f6g7h8j9k00n",
      "importCount": 1,
      "includeNotes": false,
      "includeRelationLabels": true,
      "revokedAt": null,
      "tokenPrefix": "demoShar",
      "viewCount": 3
    }
  ]
}