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

Square (BYOK) — connector documentation

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

What Square (BYOK) is for

Square (BYOK) lets an AI assistant read your own Square data through the Square API with a key you supply (access token (personal access token from your Square application, production)). Read-only: 10 tools (get_merchant, list_locations, get_location, search_orders, get_order, list_payments, get_payment, list_customers, list_catalog, get_inventory_counts). 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 connect.squareup.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Square. Square 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 Square business is my access token connected to?"
  • "What Square locations does my business have?"
  • "What are the details of my Square location L123?"
  • "What were the latest orders at my Square location?"
  • "Show the line items of Square order abc123"
  • "Show my latest Square payments"

What it does

  • get_merchant: Show the Square seller account behind the key: business name, country, currency, status and main location.
  • list_locations: List the seller's Square locations with name, address, time zone, currency, status and type. Location IDs are needed by the order and inventory tools.
  • get_location: Get one Square location's name, address, contact details, time zone, currency and status.
  • search_orders: List orders for one location, newest first or oldest first, with state, totals, customer and timestamps. Amounts are in the smallest currency unit (cents for USD). Returns up to 1000 per page; pass the returned cursor for more.
  • get_order: Get one Square order with its state, line items, totals, tenders and timestamps. Amounts are in the smallest currency unit (cents for USD).
  • list_payments: List Square payments (newest first by default) with amount, status, card brand details, receipt link and order. Amounts are in the smallest currency unit (cents for USD). Up to 100 per page; pass the returned cursor for more.
  • get_payment: Get one Square payment with status, amounts, refunds total, source type, receipt number and link.
  • list_customers: List customer profiles of the seller's Customer Directory with name, email, phone and creation date. Up to 100 per page; pass the returned cursor for more.
  • list_catalog: List Square catalog objects of chosen types (items, variations with SKU and price, categories, taxes, discounts). Prices are in the smallest currency unit. Pass the returned cursor for more.
  • get_inventory_counts: Get current inventory counts (quantity and state such as IN_STOCK) for catalog item variations at one location, newest calculation first. Up to 1000 per page.

BYOK key

You bring your own Square access token (personal access token from your Square application, production) (https://developer.squareup.com/apps). 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 connect.squareup.com 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 Square API (connect.squareup.com) with a BYOK key; documentation: https://developer.squareup.com/reference/square. 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 Square. Square 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 Square account.

Built for: Worldwide. Languages: English.