Teams

List a team’s shares ledger

User-gated (chrm_user_* or session); the caller must be an owner/admin of the team. Unions grants, invitations, and live share links across every app the team owns, newest first unless sort says otherwise.

get/api/v1/teams/{teamId}/shares

Request

  • Base URL: https://charm.ing
  • URL: https://charm.ing/api/v1/teams/{teamId}/shares
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token

Path parameters

teamIdstring required

Query parameters

limitinteger

Defaults to 100, capped at 500.

appIdstring
qstring

Case-insensitive match against the grantee handle/email.

scope'internal' | 'external'
kind'person' | 'invite' | 'link'
range7 | 30 | 90
sort'createdAt:desc' | 'createdAt:asc' | 'app:asc' | 'app:desc' | 'grantee:asc' | 'grantee:desc' | 'status:asc' | 'status:desc'

Order of the whole ledger, as <column>:<direction>. Defaults to createdAt:desc (newest first). Ties break by id in the same direction; a row with no grantee sorts last either way. An unknown value is rejected, not ignored. CSV exports honour it too.

cursorstring

The load-more cursor: the nextCursor of the previous page, sent with the same sort. A cursor from a different sort, or one that does not decode, is rejected with a 400. CSV exports ignore it.

format'csv'

When csv, returns text/csv instead of JSON, at a higher row cap. Any other value falls through to JSON.

Response

The team’s shares ledger, as JSON or (with format=csv) as text/csv.

oktrue required
hasMoreboolean required

True when the team has more matching shares than this page returned.

nextCursorstring nullable required

Pass back as cursor, with the same sort, for the next page. Null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.