canonical: https://jentic.com/apis/squareup.com/square-connect-api

# Squareup Square Connect API

Client library for accessing the Square Connect APIs. The API exposes 200 endpoints secured with apiKey, oauth2 authentication.

## For AI agents

Programmatically createmobileauthorizationcode, renewtoken. Covers 200 operations with apiKey, oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- CreateMobileAuthorizationCode
- RenewToken
- RevokeToken
- ObtainToken
- CreateEmployee
- ListEmployees
- RetrieveEmployee

## Use cases

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'createmobileauthorizationcode', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| 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 |

## Key resources

- **Apple Pay** — Operations for apple pay
- **Bank Accounts** — Operations for bank accounts
- **Bookings** — Operations for bookings
- **Cards** — Operations for cards
- **Cash Drawers** — Operations for cash drawers

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### 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.