List smart links
list_smart_linksSmart links (QR / NFC tag targets) of an organization with their public url, action, target, NFC card count, visit count and webhook ({ endpointId, ref } when the tag is tied to an endpoint, null otherwise). action is what the link does when scanned: join (member joins the venue; target venue::<venueId>), show (opens the venue or a benefit; target venue::<venueId> or org::<orgId>::venue::<venueId>::benefit::<benefitId>), stamp (gives a stamp; target org::<orgId>::venue::<venueId>::stampcard::<stampCardId>), redirect (target an https URL) or none (target null). Every scan of a link whose target names a venue emits a smart_link.scanned event to each of the organization's endpoints subscribed to it. webhook: { endpointId, ref } additionally ties the tag to one endpoint (its id from list_webhook_endpoints or get_pos_connection's endpoint.id; create_webhook_endpoint / set_pos_connection first): ref is that receiver's own reference for the tag, such as a cash register id, echoed to it as posRef. webhook: null drops the tie. smartCardPublicId (a card's publicId from list_nfc_cards) attaches that NFC card to the link so a tap opens it. A card already attached to another link is refused (409): first detach it with update_smart_link on that link, smartCardPublicId: null, which detaches every card from it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgId | No | Organization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization. |