Skip to main content

Square (Source)

Introduction

The Square source connector lets you connect to the Square API using a Square access token. This connector currently supports credential validation during setup. Data extraction and streams are still under development.

Setup

  1. In Square, create or obtain an access token for the account you want to connect.
  2. Decide which Square environment you want to use:
    • production: Square production API (https://connect.squareup.com)
    • sandbox: Square sandbox API (https://connect.squareupsandbox.com)
  3. In your workspace, create a new Square source and enter the configuration fields below.

Authentication

Square authentication uses a Bearer access token.

During setup, the connector validates your credentials by calling:

  • GET /v2/merchants/me

If validation fails, double-check that:

  • the token is correct and active
  • the token matches the selected environment (production vs sandbox)

Configuration

FieldTypeRequiredDescription
environmentstringYesSquare environment to use. Must be either production or sandbox (case-insensitive).
access_tokenstringYesSquare access token used for Bearer authentication.

Streams

No streams are currently available. The connector’s extraction logic is still in development.