Square for AI agents
Agents read Square at once. Changes and sends are held for a person's approval by default.
About Square
Square provides payment processing, POS systems, invoicing, and e-commerce tools, enabling sellers to accept card payments and manage their business
What an agent can do in Square
Every Square action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Square without asking first. 58 actions.
- Get BookingRetrieves detailed information about a specific Square booking by its ID. Returns the complete booking object including appointment segments, customer notes, seller notes, location details, creator in
- Get Current MerchantTool to retrieve merchant information associated with the access token using Square's GraphQL API. Use when you need to obtain the merchant ID required for other GraphQL queries, or to get merchant de
- Get Loyalty AccountTool to retrieve detailed information about a specific Square loyalty account by ID. Use when you need to fetch loyalty account data including balance, lifetime points, customer association, and point
- Get MerchantTool to retrieve detailed information about a specific Square merchant by ID. Use when you need to fetch merchant profile data including business name, country, currency, and main location ID. Use 'me
- Get Payment RefundRetrieves a specific payment refund by its unique ID from Square. Returns complete refund details including amount, status, associated payment and order IDs, and refund destination information. Use th
- Get SubscriptionRetrieves detailed information about a specific Square customer subscription by its ID. Use this action when you need to fetch subscription details including status, billing information, plan variatio
- Get Team MemberTool to retrieve detailed information about a specific Square team member by ID. Use when you need to fetch team member profile data including name, contact information, location assignments, and wage
- List CardsTool to retrieve cards on file associated with a Square account. Use when you need to list saved payment methods for a merchant or customer for payment processing or management purposes. Returns a max
- List ChannelsTool to list requested channels from Square. Use when you need to retrieve channel information for a specific reference type, reference ID, or status.
- List Customer GroupsTool to retrieve the list of customer groups of a business. Use when you need to discover customer group IDs or list all customer groups for segmentation and targeting purposes.
- List CustomersTool to retrieve customer profiles associated with a Square account. Use when you need to list customers for CRM, reporting, or customer management purposes. Only returns profiles with public informat
- List Customer SegmentsTool to retrieve the list of customer segments of a business. Use when you need to discover customer segment IDs for targeting or filtering customer groups in Square.
Show all 58
- List LocationsTool to retrieve all business locations from a Square account. Use when you need to discover available location IDs for other Square API calls that require location_id parameter (like listing invoices
- List MerchantsTool to retrieve merchant account information associated with the access token. Use when you need to get merchant profile details including business name, country, currency, and main location ID.
- List PaymentsTool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS. Use when you need to retrieve payment records for reporting, analytics, or reconcilia
- List SubscriptionsTool to search and list Square customer billing subscriptions. Use this action when you need to retrieve subscription information for customers, filter subscriptions by location, or view all active su
- Retrieve Bulk CustomersTool to retrieve multiple customer profiles in a single request. Use when you need to efficiently fetch up to 100 customer profiles by their IDs.
- Retrieve CustomerTool to retrieve detailed information about a specific Square customer by ID. Use when you need to fetch customer profile data including contact information, preferences, and group memberships.
- Retrieve Inventory ChangesRetrieves the inventory change history for a catalog object at specified locations. Returns adjustments, physical counts, and transfers sorted by occurrence timestamp (newest first). Use this action w
- Batch Retrieve Inventory CountsRetrieve inventory counts for multiple catalog objects and locations in a single batch request. Use this action when you need to efficiently check inventory levels across multiple item variations, loc
- Retrieve LocationTool to retrieve detailed information about a specific Square location by ID. Use when you need to get complete details about a specific location, including address, business hours, contact informatio
- Search Booking AvailabilitySearches for available appointment time slots for booking services at Square locations. Use this action when you need to find open booking slots for a specific service, location, and time range. This
- Search Catalog ObjectsSearches for catalog objects (items, categories, taxes, discounts, etc.) in the Square catalog. Use this action when you need to find specific catalog items by name, SKU, category, or other attributes
- Search CustomersTool to search customer profiles in Square Customer Directory. Use when you need to find customers by email, phone, creation date, or other filters. Returns paginated results with optional total count
- Search OrdersTool to search orders across one or more Square locations with filters. Use when you need to find orders within a date range, by state, by customer, or other criteria. This is the primary way Square e
- Get Business Booking ProfileTool to retrieve the business booking profile for a Square merchant via GraphQL. Use when you need to check if bookings are enabled, view cancellation policies, or access booking configuration setting
- Get Customer Custom AttributeRetrieves a custom attribute from a customer profile in Square. Use this when you need to access specific custom data associated with a customer, such as preferences, external IDs, or other merchant-d
- Get Customer Custom Attribute DefinitionTool to retrieve a customer-related custom attribute definition from Square. Use when you need to fetch the schema, visibility, or metadata of a specific custom attribute definition by its key.
- Get Customers via GraphQLTool to retrieve customer profiles from Square Customer Directory using GraphQL API. Use when you need to fetch customer information including name, contact details, and profile data for a specific me
- Get Dispute EvidenceRetrieves detailed information about a specific piece of evidence that was uploaded for a dispute. Use this action to: - Get metadata about evidence (file details, upload time, evidence type) - Verify
- Get Gift Card From GANRetrieves detailed information about a gift card by its GAN (gift card account number). Use this action when you need to look up a gift card using the GAN that buyers use to make purchases or check ba
- Get InvoiceRetrieves detailed information about a specific Square invoice by its ID. Returns the complete invoice object including payment requests, recipient details, accepted payment methods, custom fields, at
- Get Online Checkout Location SettingsTool to retrieve location-level settings for Square online checkout. Use when you need to get checkout configuration including customer notes, policies, branding, and tipping options for a specific lo
- List Customer Custom Attribute DefinitionsTool to list customer-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to customer profiles.
- List Customer Custom Attribute Definitions (GraphQL)Tool to retrieve customer custom attribute definitions via Square's GraphQL API. Use when you need to discover available custom attributes and their metadata for customer profiles. Alpha feature.
- List Customer Custom AttributesTool to list custom attributes for a customer profile. Use when you need to retrieve all custom data associated with a specific customer, including optional definitions that provide metadata about eac
- List Dispute EvidenceTool to list evidence items associated with a given dispute. Endpoint: GET /v2/disputes/{dispute_id}/evidence
- List InvoicesTool to list invoices for a Square location.
- List Location Custom Attribute DefinitionsTool to list location-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to location profiles.
- List Locations Custom AttributesTool to list custom attributes for a specific location in Square. Use when you need to retrieve all custom attribute values associated with a particular location.
- List Merchant Custom Attribute DefinitionsTool to list merchant-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to merchant profiles.
- List Merchants Custom AttributesTool to list custom attributes for a specific merchant in Square. Use when you need to retrieve all custom attribute values associated with a particular merchant.
- List Webhook Event TypesTool to list available webhook event types. Use when you need to discover event types before creating or updating a webhook subscription.
- List Webhook SubscriptionsList all webhook subscriptions owned by your application. Returns webhook subscriptions with their event types, notification URLs, and status. Supports filtering by enabled/disabled status, sorting by
- Retrieve ChannelRetrieve a Square channel by its ID. Channels represent different distribution points for catalog content, including physical locations and online platforms. Use this to get detailed information about
- Bulk Retrieve ChannelsTool to bulk retrieve multiple Square channels by their IDs in a single request. Use when you need to fetch specific channels by their unique identifiers rather than listing all channels.
- Retrieve Customer GroupTool to retrieve a specific Square customer group by ID. Use when you need to fetch details about a customer group including its name and timestamps.
- Retrieve Customer SegmentTool to retrieve a specific customer segment by its ID. Use when you need to get details about a customer segment including its name and timestamps.
- Retrieve DisputeTool to retrieve a Square dispute by ID. Endpoint: GET /v2/disputes/{dispute_id}
- Retrieve Location Custom AttributeRetrieves a custom attribute associated with a location in Square. Use this when you need to access specific custom data associated with a location, such as metadata, external IDs, or other merchant-d
- Retrieve Location Custom Attribute DefinitionTool to retrieve a location-related custom attribute definition. Use when you need to get the schema, visibility, and metadata for a custom attribute associated with locations.
- Retrieve Merchant Custom AttributeRetrieves a custom attribute associated with a merchant in Square. Use this when you need to access specific custom data associated with a merchant, such as metadata, external IDs, or other merchant-d
- Retrieve Merchant Custom Attribute DefinitionTool to retrieve a merchant-related custom attribute definition from Square. Use when you need to fetch the schema, visibility, or metadata of a specific custom attribute definition by its key.
- Retrieve MerchantsTool to retrieve merchant information including status, main location details, and capabilities using Square's GraphQL API. Use when you need to fetch merchant profile data for specific merchant IDs.
- Retrieve OrderRetrieves detailed information about a specific Square order by its ID. Use this tool when you need to: - Fetch complete details of an order including line items, pricing, taxes, and discounts - Check
- Retrieve Payment LinkRetrieves a Square-hosted payment link by ID. Returns complete payment link details including the checkout URL, associated order ID, checkout options, pre-populated buyer data, and creation timestamps
- Retrieve Token StatusTool to retrieve information about an OAuth access token or personal access token. Use when you need to verify token validity, check token expiration, inspect authorized scopes, or validate merchant a
- Retrieve Webhook SubscriptionRetrieve a Square webhook subscription by its ID. Returns subscription details including name, enabled status, event types, notification URL, and signature key. Note: Requires personal access token au
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 57 actions.
- Batch Create Inventory ChangesApplies multiple inventory adjustments and physical counts in a single batch request. Returns the created changes and current inventory counts for all affected items. Use this action when you need to
- Create Bulk CustomersTool to create multiple customer profiles in a single request. Use when you need to efficiently create up to 100 customers at once. Each customer is identified by a unique idempotency key.
- Create CustomerTool to create a new customer profile in Square. Use when you need to add a customer to the Square account. At least one of given_name, family_name, company_name, email_address, or phone_number is req
- Create Gift Card ActivityCreates a gift card activity to manage gift card balances. This action supports multiple activity types including ACTIVATE (initiate a gift card with an opening balance), LOAD (add funds), REDEEM (wit
- Create LocationTool to create a new business location in a Square account. Use when you need to add a new physical or mobile location for the merchant.
- Create RefundRefunds a Square payment in full or partially. Use this action when you need to return funds to a customer for a completed payment, such as for returned products, cancelled services, or billing errors
- Create Team MemberTool to create a new team member in Square. Creates a team member profile that can be used to assign permissions and track employee data. Use when you need to add a new employee or staff member to the
- Delete Catalog ObjectTool to delete a Square catalog object by ID. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (cascading deletion). Use this action when you ne
- Bulk Delete CustomersTool to bulk delete customer profiles from Square. Use when you need to delete multiple customer profiles at once (1-100 customers per request). Each successful deletion returns an empty object; faile
- Pay OrderPays an existing Square order by processing approved payments and completing the transaction. Use this action when you need to finalize payment on an order that has already been created and has associ
- Update BookingUpdates an existing Square booking with new appointment details, times, notes, or team members. Use when you need to modify a booking's start time, change appointment segments, update customer or sell
- Update CustomerTool to update an existing Square customer profile. Use when you need to modify customer details like name, email, address, or phone number. Supports sparse updates: only include fields you want to ch
Show all 57
- Bulk Update CustomersTool to update multiple customer profiles in a single batch operation. Use when you need to efficiently update 1-100 customer profiles at once. Each update request includes the customer ID as a key an
- Update LocationTool to update an existing business location in a Square account. Use when you need to modify location details like name, description, address, business hours, contact information, or social media pro
- Update Team MemberTool to update an existing Square team member's information. Use when you need to modify team member details like name, email, phone number, status, location assignments, or wage settings. Supports sp
- Upsert Catalog ObjectCreates or updates a catalog object in the Square catalog. Use when you need to add or modify items, variations, categories, taxes, discounts, or other catalog entities in the merchant's inventory sys
- Batch Upsert Catalog ObjectsCreates or updates multiple catalog objects in a single batch operation. Use this action when you need to efficiently manage catalog items, categories, discounts, taxes, or other catalog entities in b
- Accept DisputeAccept a dispute and acknowledge liability, returning funds to the cardholder. When you accept a dispute, Square debits the disputed amount from your account and updates the dispute state to ACCEPTED.
- Add Group to CustomerTool to add a customer to a customer group. Use when you need to associate a customer with a specific group for targeted marketing, loyalty programs, or customer segmentation.
- Cancel BookingCancels an existing Square booking, terminating the reservation. Use this action when a customer or seller needs to cancel a scheduled appointment. The booking must be in a cancellable state, and the
- Cancel PaymentCancels (voids) a payment that is in APPROVED status. This is typically used in delayed capture scenarios where a payment was authorized but not yet captured, allowing you to void the authorization be
- Create CardTool to create a card on file. Use when you need to securely store a customer's card for future payments. Requires a valid nonce or payment ID.
- Create Customer Custom Attribute DefinitionTool to create a customer-related custom attribute definition. Use when you need to define a new custom attribute that can be applied to customer profiles. Custom attributes allow storing additional s
- Create Customer GroupTool to create a new customer group for a business. Use when you need to organize customers into groups for targeted marketing or segmentation.
- Create Dispute Evidence TextUpload text evidence for a dispute challenge. Use this to submit textual information (up to 500 characters) that supports your case in a payment dispute. After uploading all evidence, you must call Su
- Create Location Custom Attribute DefinitionTool to create a location-related custom attribute definition. Use when you need to define new custom attributes for Square location objects to store additional business-specific data.
- Delete Catalog Objects (Batch)Deletes a set of CatalogObjects based on a list of target object IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted
- Delete CustomerTool to delete a Square customer profile. Use when you need to permanently remove a customer record from Square.
- Delete Customer Custom AttributeTool to delete a custom attribute from a customer profile. Use when you need to remove custom data associated with a specific customer. Requires the CUSTOMERS_WRITE OAuth permission scope.
- Delete Customer Custom Attribute DefinitionTool to delete a customer-related custom attribute definition. Use when you need to remove a custom attribute definition that is no longer needed. This action requires CUSTOMERS_WRITE permission.
- Delete Customer GroupTool to delete a customer group by its ID. Use when you need to permanently remove a customer group from Square.
- Delete Dispute EvidenceRemoves a specific piece of evidence from a dispute. Evidence that is removed will NOT be sent to the bank. This action requires the DISPUTES_WRITE permission scope. Important: You CANNOT remove evide
- Delete Invoice AttachmentTool to delete an attachment from a Square invoice. Endpoint: DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}
- Delete Location Custom AttributeTool to delete a custom attribute from a location. Use when you need to remove custom data associated with a specific business location. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.
- Delete Location Custom Attribute DefinitionTool to delete a location-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to locations. Use when you need to remove obsolete
- Delete Locations Custom Attributes (Batch)Tool to delete custom attributes from multiple locations in a single batch request. Use when you need to remove custom metadata from multiple business locations efficiently. To delete custom attribute
- Delete Merchant Custom AttributeTool to delete a custom attribute from a merchant profile. Use when you need to remove custom data associated with a specific merchant. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.
- Delete Merchant Custom Attribute DefinitionTool to delete a merchant-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to merchants. Use when you need to remove obsolete
- Delete Merchants Custom Attributes (Batch)Tool to delete custom attributes from multiple merchants in a single batch request. Use when you need to remove custom metadata from merchant profiles efficiently. To delete custom attributes owned by
- Delete Webhook SubscriptionPermanently deletes a webhook subscription by its ID. Once deleted, the subscription will no longer receive event notifications. This action cannot be undone. Note: Webhook subscriptions are applicati
- Link Customer to Gift CardTool to link a customer to a gift card in Square. Links the customer profile to the gift card, adding their ID to the gift card's customer_ids list. Use when you need to associate a customer with a gi
- Remove Group From CustomerRemoves a customer from a customer group. Use this when you need to disassociate a customer from a specific group. Once removed, the customer will no longer be part of the group and won't receive grou
- Submit Dispute EvidenceSubmits evidence for a dispute to the cardholder's bank. IMPORTANT: You must upload evidence FIRST using CreateDisputeEvidenceText or CreateDisputeEvidenceFile before calling this endpoint. Once evide
- Test Webhook SubscriptionTests a webhook subscription by sending a test event to the configured notification URL. Use this to verify that your webhook endpoint is correctly receiving and processing Square events. The response
- Update Customer Custom Attribute DefinitionTool to update a customer-related custom attribute definition in Square. Use when you need to modify the name, description, visibility, or schema of an existing custom attribute definition. Supports s
- Update Customer GroupTool to update a customer group's information by its ID. Use when you need to modify the name or other attributes of an existing customer group in Square.
- Update Location Custom Attribute DefinitionTool to update a location-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing location custom attribute definition.
- Update Merchant Custom Attribute DefinitionTool to update a merchant-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing merchant custom attribute definition.
- Update Online Checkout Location SettingsTool to update location-level settings for Square online checkout. Use when you need to modify checkout configuration including customer notes, policies, branding, and tipping options for a specific l
- Update Webhook SubscriptionTool to update a Square webhook subscription. Use when you need to modify subscription settings such as name, enabled state, event types, notification URL, or API version of an existing webhook subscr
- Update Webhook Subscription Signature KeyTool to rotate the signature key for a webhook subscription. Use when you need to replace the current signature key for security purposes.
- Upsert Customer Custom AttributeTool to create or update a custom attribute for a customer profile. Use when you need to store custom data on a customer record, such as preferences, loyalty tiers, or external system IDs. The custom
- Batch Upsert Customer Custom AttributesTool to create or update custom attributes for multiple customers in a single batch request. Use when you need to set custom data on customer profiles (e.g., preferences, loyalty tiers, tags). Support
- Upsert Location Custom AttributeTool to create or update a custom attribute for a location. Use when you need to store custom data on a location record, such as capacity limits, special features, or external system IDs. The custom a
- Batch Upsert Locations Custom AttributesTool to create or update custom attributes for multiple locations in a single batch request. Use when you need to set custom data on location records (e.g., store ratings, delivery zones, tags). Suppo
- Upsert Merchant Custom AttributeTool to create or update a custom attribute for a merchant profile. Use when you need to store custom data on a merchant record, such as business notes, external system IDs, or configuration values. T
- Batch Upsert Merchants Custom AttributesTool to create or update custom attributes for multiple merchants in a single batch request. Use when you need to set custom data on merchant profiles (e.g., business types, establishment dates, merch
Changes wait in Needs you
Changes and sends in Square are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Square questions
Can an agent change data in Square on its own?
Not by default. Changes and sends in Square are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Square?
This connector lists 58 read actions. Reads run at once, without waiting for approval.
How does Square connect?
It connects with OAuth 2.0. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.