Skip to main content

Membership

Membership endpoints let you issue, revoke, transfer, and query membership tokens associated with a wallet. Use them to grant or inspect access patterns that your application enforces.

Issue membership token(s)​

POST /api/v1/membership/issue

cURL​

curl -s -X POST "$FREEQ_API_URL/api/v1/membership/issue" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"membershipType":"write:admin","walletAddress":"0xWALLET","expiration":0,"transferable":false,"override":false}]'

Revoke membership​

POST /api/v1/membership/revoke

cURL​

curl -s -X POST "$FREEQ_API_URL/api/v1/membership/revoke" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tokenId":"123","hardDelete":true}'

Transfer membership​

POST /api/v1/membership/transfer

cURL​

curl -s -X POST "$FREEQ_API_URL/api/v1/membership/transfer" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"0xFROM","to":"0xTO","tokenId":"123"}'

View memberships​

GET /api/v1/membership/view

cURL​

curl -s "$FREEQ_API_URL/api/v1/membership/view?walletAddress=0xWALLET&membershipType=write:admin&includeRevoked=false&includeExpired=false" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN"