Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Smile.io (BYOK) — connector documentation

  • MCP endpoint: https://byok-smile.connectorbay.com/mcp
  • REST API: POST https://byok-smile.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-smile.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Smile.io Smile private API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-smile.connectorbay.com/health · Tool schemas: https://byok-smile.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-smile · agent@connectorbay.com

What Smile.io (BYOK) is for

Smile.io (BYOK) lets an AI assistant read your own Smile.io data through the Smile.io API with a key you supply (Smile private API key). Read-only: 10 tools (list_customers, get_customer, list_points_transactions, get_points_transaction, list_earning_rules, list_points_products, get_points_product, get_points_settings, get_referral_settings, list_vip_tiers). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.smile.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Smile.io. Smile.io and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which customers in my Smile program have the most points?"
  • "How many points does Smile customer 12345 have?"
  • "What points activity did Smile customer 12345 have recently?"
  • "Show Smile points transaction 555."
  • "How can customers earn points in my Smile program?"
  • "What rewards can Smile members redeem points for?"

What it does

  • list_customers: List loyalty customers by Smile id, state (candidate, member, disabled), points balance and VIP tier. Names, email and birth date are left out. Newest first.
  • get_customer: Get one loyalty customer by Smile customer id: state, points balance, VIP tier and VIP progress. Name, email and birth date are left out.
  • list_points_transactions: List points transactions (earned, spent, adjusted) with customer id, point change, description and time. Optionally for one customer. Newest first.
  • get_points_transaction: Get one points transaction by id.
  • list_earning_rules: List the ways customers earn points (earning rules): name, reward type and value, VIP restrictions and limits.
  • list_points_products: List rewards customers can buy with points (points products): reward name, description, fixed price or variable range. Pages by page number.
  • get_points_product: Get one points product (a reward customers can buy with points) by id.
  • get_points_settings: Show how the program names its points (singular and plural label).
  • get_referral_settings: Show whether the referral program is active and the sender and receiver reward names.
  • list_vip_tiers: List VIP tiers with name and the milestone needed to reach each, optionally with perks and entry rewards.

BYOK key

You bring your own Smile.io Smile private API key (https://help.smile.io/en/articles/11328240-manage-your-api-keys). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.smile.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Smile.io API (api.smile.io) with a BYOK key; documentation: https://dev.smile.io/api/introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Smile.io. Smile.io and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Smile.io account.

Built for: Worldwide. Languages: English.