Square

Square

API version: 2.0

Auth

OAuth2 | ApiKey Authorization in header

Base URL

https://connect.squareup.com

Setup

1. Set your API key in the appropriate header
2. GET /v2/bank-accounts -- verify access
3. POST /mobile/authorization-code -- create first authorization-code

Endpoints

327 endpoints across 34 groups. See references/api-spec.lap for full details.

mobile

oauth2

{location_id}

apple-pay

bank-accounts

bookings

cards

cash-drawers

catalog

channels

customers

devices

disputes

employees

events

gift-cards

inventory

invoices

labor

locations

loyalty

merchants

online-checkout

orders

payments

payouts

refunds

sites

subscriptions

team-members

terminals

transfer-orders

vendors

webhooks

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a authorization-code?" -> POST /mobile/authorization-code
• "Create a revoke?" -> POST /oauth2/revoke
• "Create a token?" -> POST /oauth2/token
• "Create a status?" -> POST /oauth2/token/status
• "List all orders?" -> GET /v1/{location_id}/orders
• "Get order details?" -> GET /v1/{location_id}/orders/{order_id}
• "Update a order?" -> PUT /v1/{location_id}/orders/{order_id}
• "Create a domain?" -> POST /v2/apple-pay/domains
• "List all bank-accounts?" -> GET /v2/bank-accounts
• "Get by-v1-id details?" -> GET /v2/bank-accounts/by-v1-id/{v1_bank_account_id}
• "Get bank-account details?" -> GET /v2/bank-accounts/{bank_account_id}
• "List all bookings?" -> GET /v2/bookings
• "Create a booking?" -> POST /v2/bookings
• "Create a search?" -> POST /v2/bookings/availability/search
• "Create a bulk-retrieve?" -> POST /v2/bookings/bulk-retrieve
• "List all business-booking-profile?" -> GET /v2/bookings/business-booking-profile
• "List all custom-attribute-definitions?" -> GET /v2/bookings/custom-attribute-definitions
• "Create a custom-attribute-definition?" -> POST /v2/bookings/custom-attribute-definitions
• "Delete a custom-attribute-definition?" -> DELETE /v2/bookings/custom-attribute-definitions/{key}
• "Get custom-attribute-definition details?" -> GET /v2/bookings/custom-attribute-definitions/{key}
• "Update a custom-attribute-definition?" -> PUT /v2/bookings/custom-attribute-definitions/{key}
• "Create a bulk-delete?" -> POST /v2/bookings/custom-attributes/bulk-delete
• "Create a bulk-upsert?" -> POST /v2/bookings/custom-attributes/bulk-upsert
• "List all location-booking-profiles?" -> GET /v2/bookings/location-booking-profiles
• "Get location-booking-profile details?" -> GET /v2/bookings/location-booking-profiles/{location_id}
• "List all team-member-booking-profiles?" -> GET /v2/bookings/team-member-booking-profiles
• "Create a bulk-retrieve?" -> POST /v2/bookings/team-member-booking-profiles/bulk-retrieve
• "Get team-member-booking-profile details?" -> GET /v2/bookings/team-member-booking-profiles/{team_member_id}
• "Get booking details?" -> GET /v2/bookings/{booking_id}
• "Update a booking?" -> PUT /v2/bookings/{booking_id}
• "Create a cancel?" -> POST /v2/bookings/{booking_id}/cancel
• "List all custom-attributes?" -> GET /v2/bookings/{booking_id}/custom-attributes
• "Delete a custom-attribute?" -> DELETE /v2/bookings/{booking_id}/custom-attributes/{key}
• "Get custom-attribute details?" -> GET /v2/bookings/{booking_id}/custom-attributes/{key}
• "Update a custom-attribute?" -> PUT /v2/bookings/{booking_id}/custom-attributes/{key}
• "List all cards?" -> GET /v2/cards
• "Create a card?" -> POST /v2/cards
• "Get card details?" -> GET /v2/cards/{card_id}
• "Create a disable?" -> POST /v2/cards/{card_id}/disable
• "List all shifts?" -> GET /v2/cash-drawers/shifts
• "Get shift details?" -> GET /v2/cash-drawers/shifts/{shift_id}
• "List all events?" -> GET /v2/cash-drawers/shifts/{shift_id}/events
• "Create a batch-delete?" -> POST /v2/catalog/batch-delete
• "Create a batch-retrieve?" -> POST /v2/catalog/batch-retrieve
• "Create a batch-upsert?" -> POST /v2/catalog/batch-upsert
• "Create a image?" -> POST /v2/catalog/images
• "Update a image?" -> PUT /v2/catalog/images/{image_id}
• "List all info?" -> GET /v2/catalog/info
• "List all list?" -> GET /v2/catalog/list
• "Create a object?" -> POST /v2/catalog/object
• "Delete a object?" -> DELETE /v2/catalog/object/{object_id}
• "Get object details?" -> GET /v2/catalog/object/{object_id}
• "Create a search?" -> POST /v2/catalog/search
• "Create a search-catalog-item?" -> POST /v2/catalog/search-catalog-items
• "Create a update-item-modifier-list?" -> POST /v2/catalog/update-item-modifier-lists
• "Create a update-item-taxe?" -> POST /v2/catalog/update-item-taxes
• "List all channels?" -> GET /v2/channels
• "Create a bulk-retrieve?" -> POST /v2/channels/bulk-retrieve
• "Get channel details?" -> GET /v2/channels/{channel_id}
• "List all customers?" -> GET /v2/customers
• "Create a customer?" -> POST /v2/customers
• "Create a bulk-create?" -> POST /v2/customers/bulk-create
• "Create a bulk-delete?" -> POST /v2/customers/bulk-delete
• "Create a bulk-retrieve?" -> POST /v2/customers/bulk-retrieve
• "Create a bulk-update?" -> POST /v2/customers/bulk-update
• "List all custom-attribute-definitions?" -> GET /v2/customers/custom-attribute-definitions
• "Create a custom-attribute-definition?" -> POST /v2/customers/custom-attribute-definitions
• "Delete a custom-attribute-definition?" -> DELETE /v2/customers/custom-attribute-definitions/{key}
• "Get custom-attribute-definition details?" -> GET /v2/customers/custom-attribute-definitions/{key}
• "Update a custom-attribute-definition?" -> PUT /v2/customers/custom-attribute-definitions/{key}
• "Create a bulk-upsert?" -> POST /v2/customers/custom-attributes/bulk-upsert
• "List all groups?" -> GET /v2/customers/groups
• "Create a group?" -> POST /v2/customers/groups
• "Delete a group?" -> DELETE /v2/customers/groups/{group_id}
• "Get group details?" -> GET /v2/customers/groups/{group_id}
• "Update a group?" -> PUT /v2/customers/groups/{group_id}
• "Create a search?" -> POST /v2/customers/search
• "List all segments?" -> GET /v2/customers/segments
• "Get segment details?" -> GET /v2/customers/segments/{segment_id}
• "Delete a customer?" -> DELETE /v2/customers/{customer_id}
• "Get customer details?" -> GET /v2/customers/{customer_id}
• "Update a customer?" -> PUT /v2/customers/{customer_id}
• "Create a card?" -> POST /v2/customers/{customer_id}/cards
• "Delete a card?" -> DELETE /v2/customers/{customer_id}/cards/{card_id}
• "List all custom-attributes?" -> GET /v2/customers/{customer_id}/custom-attributes
• "Delete a custom-attribute?" -> DELETE /v2/customers/{customer_id}/custom-attributes/{key}
• "Get custom-attribute details?" -> GET /v2/customers/{customer_id}/custom-attributes/{key}
• "Delete a group?" -> DELETE /v2/customers/{customer_id}/groups/{group_id}
• "Update a group?" -> PUT /v2/customers/{customer_id}/groups/{group_id}
• "List all devices?" -> GET /v2/devices
• "List all codes?" -> GET /v2/devices/codes
• "Create a code?" -> POST /v2/devices/codes
• "Get code details?" -> GET /v2/devices/codes/{id}
• "Get device details?" -> GET /v2/devices/{device_id}
• "List all disputes?" -> GET /v2/disputes
• "Get dispute details?" -> GET /v2/disputes/{dispute_id}
• "Create a accept?" -> POST /v2/disputes/{dispute_id}/accept
• "List all evidence?" -> GET /v2/disputes/{dispute_id}/evidence
• "Create a evidence-file?" -> POST /v2/disputes/{dispute_id}/evidence-files
• "Create a evidence-text?" -> POST /v2/disputes/{dispute_id}/evidence-text
• "Delete a evidence?" -> DELETE /v2/disputes/{dispute_id}/evidence/{evidence_id}
• "Get evidence details?" -> GET /v2/disputes/{dispute_id}/evidence/{evidence_id}
• "Create a submit-evidence?" -> POST /v2/disputes/{dispute_id}/submit-evidence
• "List all employees?" -> GET /v2/employees
• "Get employee details?" -> GET /v2/employees/{id}
• "Create a event?" -> POST /v2/events
• "List all types?" -> GET /v2/events/types
• "List all gift-cards?" -> GET /v2/gift-cards
• "Create a gift-card?" -> POST /v2/gift-cards
• "List all activities?" -> GET /v2/gift-cards/activities
• "Create a activity?" -> POST /v2/gift-cards/activities
• "Create a from-gan?" -> POST /v2/gift-cards/from-gan
• "Create a from-nonce?" -> POST /v2/gift-cards/from-nonce
• "Create a link-customer?" -> POST /v2/gift-cards/{gift_card_id}/link-customer
• "Create a unlink-customer?" -> POST /v2/gift-cards/{gift_card_id}/unlink-customer
• "Get gift-card details?" -> GET /v2/gift-cards/{id}
• "Get adjustment details?" -> GET /v2/inventory/adjustment/{adjustment_id}
• "Get adjustment details?" -> GET /v2/inventory/adjustments/{adjustment_id}
• "Create a batch-change?" -> POST /v2/inventory/batch-change
• "Create a batch-retrieve-change?" -> POST /v2/inventory/batch-retrieve-changes
• "Create a batch-retrieve-count?" -> POST /v2/inventory/batch-retrieve-counts
• "Create a batch-create?" -> POST /v2/inventory/changes/batch-create
• "Create a batch-retrieve?" -> POST /v2/inventory/changes/batch-retrieve
• "Create a batch-retrieve?" -> POST /v2/inventory/counts/batch-retrieve
• "Get physical-count details?" -> GET /v2/inventory/physical-count/{physical_count_id}
• "Get physical-count details?" -> GET /v2/inventory/physical-counts/{physical_count_id}
• "Get transfer details?" -> GET /v2/inventory/transfers/{transfer_id}
• "Get inventory details?" -> GET /v2/inventory/{catalog_object_id}
• "List all changes?" -> GET /v2/inventory/{catalog_object_id}/changes
• "List all invoices?" -> GET /v2/invoices
• "Create a invoice?" -> POST /v2/invoices
• "Create a search?" -> POST /v2/invoices/search
• "Delete a invoice?" -> DELETE /v2/invoices/{invoice_id}
• "Get invoice details?" -> GET /v2/invoices/{invoice_id}
• "Update a invoice?" -> PUT /v2/invoices/{invoice_id}
• "Create a attachment?" -> POST /v2/invoices/{invoice_id}/attachments
• "Delete a attachment?" -> DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}
• "Create a cancel?" -> POST /v2/invoices/{invoice_id}/cancel
• "Create a publish?" -> POST /v2/invoices/{invoice_id}/publish
• "List all break-types?" -> GET /v2/labor/break-types
• "Create a break-type?" -> POST /v2/labor/break-types
• "Delete a break-type?" -> DELETE /v2/labor/break-types/{id}
• "Get break-type details?" -> GET /v2/labor/break-types/{id}
• "Update a break-type?" -> PUT /v2/labor/break-types/{id}
• "List all employee-wages?" -> GET /v2/labor/employee-wages
• "Get employee-wage details?" -> GET /v2/labor/employee-wages/{id}
• "Create a scheduled-shift?" -> POST /v2/labor/scheduled-shifts
• "Create a bulk-publish?" -> POST /v2/labor/scheduled-shifts/bulk-publish
• "Create a search?" -> POST /v2/labor/scheduled-shifts/search
• "Get scheduled-shift details?" -> GET /v2/labor/scheduled-shifts/{id}
• "Update a scheduled-shift?" -> PUT /v2/labor/scheduled-shifts/{id}
• "Create a publish?" -> POST /v2/labor/scheduled-shifts/{id}/publish
• "Create a shift?" -> POST /v2/labor/shifts
• "Create a search?" -> POST /v2/labor/shifts/search
• "Delete a shift?" -> DELETE /v2/labor/shifts/{id}
• "Get shift details?" -> GET /v2/labor/shifts/{id}
• "Update a shift?" -> PUT /v2/labor/shifts/{id}
• "List all team-member-wages?" -> GET /v2/labor/team-member-wages
• "Get team-member-wage details?" -> GET /v2/labor/team-member-wages/{id}
• "Create a timecard?" -> POST /v2/labor/timecards
• "Create a search?" -> POST /v2/labor/timecards/search
• "Delete a timecard?" -> DELETE /v2/labor/timecards/{id}
• "Get timecard details?" -> GET /v2/labor/timecards/{id}
• "Update a timecard?" -> PUT /v2/labor/timecards/{id}
• "List all workweek-configs?" -> GET /v2/labor/workweek-configs
• "Update a workweek-config?" -> PUT /v2/labor/workweek-configs/{id}
• "List all locations?" -> GET /v2/locations
• "Create a location?" -> POST /v2/locations
• "List all custom-attribute-definitions?" -> GET /v2/locations/custom-attribute-definitions
• "Create a custom-attribute-definition?" -> POST /v2/locations/custom-attribute-definitions
• "Delete a custom-attribute-definition?" -> DELETE /v2/locations/custom-attribute-definitions/{key}
• "Get custom-attribute-definition details?" -> GET /v2/locations/custom-attribute-definitions/{key}
• "Update a custom-attribute-definition?" -> PUT /v2/locations/custom-attribute-definitions/{key}
• "Create a bulk-delete?" -> POST /v2/locations/custom-attributes/bulk-delete
• "Create a bulk-upsert?" -> POST /v2/locations/custom-attributes/bulk-upsert
• "Get location details?" -> GET /v2/locations/{location_id}
• "Update a location?" -> PUT /v2/locations/{location_id}
• "Create a checkout?" -> POST /v2/locations/{location_id}/checkouts
• "List all custom-attributes?" -> GET /v2/locations/{location_id}/custom-attributes
• "Delete a custom-attribute?" -> DELETE /v2/locations/{location_id}/custom-attributes/{key}
• "Get custom-attribute details?" -> GET /v2/locations/{location_id}/custom-attributes/{key}
• "List all transactions?" -> GET /v2/locations/{location_id}/transactions
• "Get transaction details?" -> GET /v2/locations/{location_id}/transactions/{transaction_id}
• "Create a capture?" -> POST /v2/locations/{location_id}/transactions/{transaction_id}/capture
• "Create a void?" -> POST /v2/locations/{location_id}/transactions/{transaction_id}/void
• "Create a account?" -> POST /v2/loyalty/accounts
• "Create a search?" -> POST /v2/loyalty/accounts/search
• "Get account details?" -> GET /v2/loyalty/accounts/{account_id}
• "Create a accumulate?" -> POST /v2/loyalty/accounts/{account_id}/accumulate
• "Create a adjust?" -> POST /v2/loyalty/accounts/{account_id}/adjust
• "Create a search?" -> POST /v2/loyalty/events/search
• "List all programs?" -> GET /v2/loyalty/programs
• "Get program details?" -> GET /v2/loyalty/programs/{program_id}
• "Create a calculate?" -> POST /v2/loyalty/programs/{program_id}/calculate
• "List all promotions?" -> GET /v2/loyalty/programs/{program_id}/promotions
• "Create a promotion?" -> POST /v2/loyalty/programs/{program_id}/promotions
• "Get promotion details?" -> GET /v2/loyalty/programs/{program_id}/promotions/{promotion_id}
• "Create a cancel?" -> POST /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel
• "Create a reward?" -> POST /v2/loyalty/rewards
• "Create a search?" -> POST /v2/loyalty/rewards/search
• "Delete a reward?" -> DELETE /v2/loyalty/rewards/{reward_id}
• "Get reward details?" -> GET /v2/loyalty/rewards/{reward_id}
• "Create a redeem?" -> POST /v2/loyalty/rewards/{reward_id}/redeem
• "List all merchants?" -> GET /v2/merchants
• "List all custom-attribute-definitions?" -> GET /v2/merchants/custom-attribute-definitions
• "Create a custom-attribute-definition?" -> POST /v2/merchants/custom-attribute-definitions
• "Delete a custom-attribute-definition?" -> DELETE /v2/merchants/custom-attribute-definitions/{key}
• "Get custom-attribute-definition details?" -> GET /v2/merchants/custom-attribute-definitions/{key}
• "Update a custom-attribute-definition?" -> PUT /v2/merchants/custom-attribute-definitions/{key}
• "Create a bulk-delete?" -> POST /v2/merchants/custom-attributes/bulk-delete
• "Create a bulk-upsert?" -> POST /v2/merchants/custom-attributes/bulk-upsert
• "Get merchant details?" -> GET /v2/merchants/{merchant_id}
• "List all custom-attributes?" -> GET /v2/merchants/{merchant_id}/custom-attributes
• "Delete a custom-attribute?" -> DELETE /v2/merchants/{merchant_id}/custom-attributes/{key}
• "Get custom-attribute details?" -> GET /v2/merchants/{merchant_id}/custom-attributes/{key}
• "Get location-setting details?" ->

…(truncated)