Client library for accessing the Square Connect APIs
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://connect.squareup.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Client library for accessing the Square Connect APIs
| method | path | what the vendor says it does |
|---|---|---|
POST | /mobile/authorization-code | CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card rea |
POST | /oauth2/clients/{client_id}/access-token/renew | RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Migrate from |
POST | /oauth2/revoke | RevokeToken Revokes an access token generated with the OAuth flow. If an account has more than one OAuth acce |
POST | /oauth2/token | ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access t |
GET | /v1/me/employees | ListEmployees Provides summary information for all of a business's employees. V1Employees |
POST | /v1/me/employees | CreateEmployee Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with |
GET | /v1/me/employees/{employee_id} | RetrieveEmployee Provides the details for a single employee. V1Employees |
PUT | /v1/me/employees/{employee_id} | UpdateEmployee V1Employees |
GET | /v1/me/roles | ListEmployeeRoles Provides summary information for all of a business's employee roles. V1Employees |
POST | /v1/me/roles | CreateEmployeeRole Creates an employee role you can then assign to employees. Square accounts can include any |
GET | /v1/me/roles/{role_id} | RetrieveEmployeeRole Provides the details for a single employee role. V1Employees |
PUT | /v1/me/roles/{role_id} | UpdateEmployeeRole Modifies the details of an employee role. V1Employees |
GET | /v1/{location_id}/orders | ListOrders Provides summary information for a merchant's online store orders. V1Transactions |
GET | /v1/{location_id}/orders/{order_id} | RetrieveOrder Provides comprehensive information for a single online store order, including the order's histor |
PUT | /v1/{location_id}/orders/{order_id} | UpdateOrder Updates the details of an online store order. Every update you perform on an order corresponds to |
GET | /v1/{location_id}/payments | ListPayments Provides summary information for all payments taken for a given Square account during a date rang |
GET | /v1/{location_id}/payments/{payment_id} | RetrievePayment Provides comprehensive information for a single payment. V1Transactions |
GET | /v1/{location_id}/refunds | ListRefunds Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff |
POST | /v1/{location_id}/refunds | CreateRefund Issues a refund for a previously processed payment. You must issue a refund within 60 days of the |
GET | /v1/{location_id}/settlements | ListSettlements Provides summary information for all deposits and withdrawals initiated by Square to a linked |
GET | /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement Provides comprehensive information for a single settlement. The returned `Settlement` obje |
POST | /v2/apple-pay/domains | RegisterDomain Activates a domain for use with Apple Pay on the Web and Square. A validation is performed on t |
GET | /v2/bank-accounts | ListBankAccounts Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/ob |
GET | /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-0 |
GET | /v2/bank-accounts/{bank_account_id} | GetBankAccount Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/o |
POST | /v2/bookings | CreateBooking Creates a booking. Bookings |
POST | /v2/bookings/availability/search | SearchAvailability Searches for availabilities for booking. Bookings |
GET | /v2/bookings/business-booking-profile | RetrieveBusinessBookingProfile Retrieves a seller's booking profile. Bookings |
GET | /v2/bookings/team-member-booking-profiles | ListTeamMemberBookingProfiles Lists booking profiles for team members. Bookings |
GET | /v2/bookings/team-member-booking-profiles/{team_member_id} | RetrieveTeamMemberBookingProfile Retrieves a team member's booking profile. Bookings |
GET | /v2/bookings/{booking_id} | RetrieveBooking Retrieves a booking. Bookings |
PUT | /v2/bookings/{booking_id} | UpdateBooking Updates a booking. Bookings |
POST | /v2/bookings/{booking_id}/cancel | CancelBooking Cancels an existing booking. Bookings |
GET | /v2/cards | ListCards Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returne |
POST | /v2/cards | CreateCard Adds a card on file to an existing merchant. Cards |
GET | /v2/cards/{card_id} | RetrieveCard Retrieves details for a specific Card. Cards |
POST | /v2/cards/{card_id}/disable | DisableCard Disables the card, preventing any further updates or charges. Disabling an already disabled card i |
GET | /v2/cash-drawers/shifts | ListCashDrawerShifts Provides the details for all of the cash drawer shifts for a location in a date range. Ca |
GET | /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftE |
GET | /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents Provides a paginated list of events for a single cash drawer shift. CashDrawers |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/square/connect-api-specification/master/api.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.