Squareup Square Connect API
Browse all Squareup APIs61
AI ReadinessAI-Aware (B-)61/100
Community OpenAPI document · agent-readyDeveloper ToolsSource ControlapiKey, oauth2200 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically createmobileauthorizationcode, renewtoken. Covers 200 operations with apiKey, oauth2 authentication.
Use for: I need to createmobileauthorizationcode, I want to renewtoken, Search for revoketoken, Find all obtaintoken
Not supported: Does not handle payments, communications, or crm - use for developer tools only.
Client library for accessing the Square Connect APIs. The API exposes 200 endpoints secured with apiKey, oauth2 authentication.
Install Jentic One Beta
Connect the Square Connect API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Square Connect API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsquareup.com%2Fsquare-connect-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsquareup.com%2Fsquare-connect-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Square Connect API.
CreateMobileAuthorizationCode
RenewToken
RevokeToken
ObtainToken
CreateEmployee
ListEmployees
RetrieveEmployee
Use Cases
Patterns agents use Square Connect API for, with concrete tasks.
★ Developer Tools Operations
Use the Square Connect API to perform developer tools operations programmatically. The API provides 200 endpoints covering core functionality including createmobileauthorizationcode, renewtoken, revoketoken.
Call POST /mobile/authorization-code to createmobileauthorizationcode
Automated Apple Pay Management
Automate apple pay operations by combining multiple Square Connect API endpoints. Agents can renewtoken and then revoketoken in a single workflow.
Call POST /oauth2/clients/{client_id}/access-token/renew to renewtoken, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Square Connect API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, oauth2 tokens manually.
Search Jentic for 'createmobileauthorizationcode', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
200 endpoints — client library for accessing the square connect apis.
METHOD
PATH
DESCRIPTION
POST
/mobile/authorization-code
CreateMobileAuthorizationCode
POST
/oauth2/clients/{client_id}/access-token/renew
RenewToken
POST
/oauth2/revoke
RevokeToken
POST
/oauth2/token
ObtainToken
POST
/v1/me/employees
CreateEmployee
GET
/v1/me/employees
ListEmployees
GET
/v1/me/employees/{employee_id}
RetrieveEmployee
PUT
/v1/me/employees/{employee_id}
UpdateEmployee
POST
/mobile/authorization-code
CreateMobileAuthorizationCode
POST
/oauth2/clients/{client_id}/access-token/renew
RenewToken
POST
/oauth2/revoke
RevokeToken
POST
/oauth2/token
ObtainToken
POST
/v1/me/employees
CreateEmployee
GET
/v1/me/employees
ListEmployees
GET
/v1/me/employees/{employee_id}
RetrieveEmployee
PUT
/v1/me/employees/{employee_id}
UpdateEmployee
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
Square Connect API
- AI-Aware (B-)61/100
98
Foundational Compliance54
Developer Experience & Jentic Compatibility58
AI-Readiness & Agent Experience43
Agent Usability70
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
98
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
91%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
54
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
10%
Example Density
How richly the API is illustrated with examples.
83%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
58
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C+Signals: 4
81%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
96%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
56%
Summary Coverage
Coverage of summaries across operations/tags/info.
43
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: D-Signals: 1
43%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
70
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
70%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Square Connect API by hand means running its OAuth 2.0 flow against connect.squareup.com, renewing and revoking tokens, and threading the employee id into paths yourself. Through Jentic you install once, import the Square Connect API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Square Connect puts the employee id in the URL path (/v1/me/employees/{employee_id}), so a rule can pin your agent to reading a single employee. You choose the operations it may call, so ones like creating or updating an employee are not included unless you add them.
Credential isolation
Your Square Connect OAuth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list employees' or 'get an employee by id', and Jentic returns the matching Square Connect operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Square Connect API through Jentic.
What authentication does the Square Connect API use?
The Square Connect API uses apiKey, oauth2 authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I createmobileauthorizationcode with the Square Connect API?
Yes. Use the POST /mobile/authorization-code endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Square Connect API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I createmobileauthorizationcode through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'createmobileauthorizationcode'. Jentic returns the matching Square Connect API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Square Connect API have?
The Square Connect API exposes 200 endpoints covering apple pay, bank accounts, bookings operations.
Can I limit what my agent is allowed to do with the Square Connect API?
Yes. Because you run Jentic One yourself, your own rules decide which Square Connect operations and credentials the agent may use. You can allow read-only calls like GET /v1/me/employees or GET /v1/me/employees/{employee_id} while withholding write operations such as CreateEmployee or UpdateEmployee, and because the employee id sits in the URL path you can pin the agent to a single employee record. Only the operations you grant are callable.
GET STARTED