OAUTH2
square_oauth
Developer setup
- Client idclient_id · stringRequired
- Client secretclient_secret · stringRequired
- Redirect URIoauth_redirect_uri · stringOptional
- Scopesscopes · stringOptional
User connection
No fields declared in this snapshot.
SQUARE
Square provides payment processing, POS systems, invoicing, and e-commerce tools, enabling sellers to accept card payments and manage their business
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
122
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
OAUTH2
No fields declared in this snapshot.
Capability index
Showing 61–90 of 122 actions
SQUARE_LIST_CUSTOMERS
Tool 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 information (given_name, family_name, company_name, email_address, or phone_number).
Untrusted display-only summary
SQUARE_LIST_CUSTOMER_SEGMENTS
Tool 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.
Untrusted display-only summary
SQUARE_LIST_DISPUTE_EVIDENCE
Tool to list evidence items associated with a given dispute. Endpoint: GET /v2/disputes/{dispute_id}/evidence
Untrusted display-only summary
SQUARE_LIST_INVOICES
Tool to list invoices for a Square location.
Untrusted display-only summary
SQUARE_LIST_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONS
Tool 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.
Untrusted display-only summary
SQUARE_LIST_LOCATIONS
Tool 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 or payments).
Untrusted display-only summary
SQUARE_LIST_LOCATIONS_CUSTOM_ATTRIBUTES
Tool 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.
Untrusted display-only summary
SQUARE_LIST_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONS
Tool 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.
Untrusted display-only summary
SQUARE_LIST_MERCHANTS
Tool 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.
Untrusted display-only summary
SQUARE_LIST_MERCHANTS_CUSTOM_ATTRIBUTES
Tool 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.
Untrusted display-only summary
SQUARE_LIST_PAYMENTS
Tool 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 reconciliation purposes.
Untrusted display-only summary
SQUARE_LIST_SUBSCRIPTIONS
Tool 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 subscriptions. Results are ordered chronologically by subscription creation date.
Untrusted display-only summary
SQUARE_LIST_WEBHOOK_EVENT_TYPES
Tool to list available webhook event types. Use when you need to discover event types before creating or updating a webhook subscription.
Untrusted display-only summary
SQUARE_LIST_WEBHOOK_SUBSCRIPTIONS
List 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 creation date, and pagination for large result sets. Note: Webhook subscriptions are application-level resources and r…
Untrusted display-only summary
SQUARE_PAY_ORDER
Pays 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 associated approved payments. The total amount of the payment_ids provided must equal the order total, and upon success, the…
Untrusted display-only summary
SQUARE_REMOVE_GROUP_FROM_CUSTOMER
Removes 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 group-specific benefits or targeting.
Untrusted display-only summary
SQUARE_RETRIEVE_BULK_CUSTOMERS
Tool to retrieve multiple customer profiles in a single request. Use when you need to efficiently fetch up to 100 customer profiles by their IDs.
Untrusted display-only summary
SQUARE_RETRIEVE_CHANNEL
Retrieve 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 a specific channel, including its status, associated references, and metadata.
Untrusted display-only summary
SQUARE_RETRIEVE_CHANNELS_BULK
Tool 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.
Untrusted display-only summary
SQUARE_RETRIEVE_CUSTOMER
Tool 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.
Untrusted display-only summary
SQUARE_RETRIEVE_CUSTOMER_GROUP
Tool 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.
Untrusted display-only summary
SQUARE_RETRIEVE_CUSTOMER_SEGMENT
Tool 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.
Untrusted display-only summary
SQUARE_RETRIEVE_DISPUTE
Tool to retrieve a Square dispute by ID. Endpoint: GET /v2/disputes/{dispute_id}
Untrusted display-only summary
SQUARE_RETRIEVE_INVENTORY_CHANGES
Retrieves 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 when you need to track inventory movements, audit stock changes, or reconcile inventory discrepancies for a specific cat…
Untrusted display-only summary
SQUARE_RETRIEVE_INVENTORY_COUNTS_BATCH
Retrieve 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, locations, or states. The endpoint supports filtering by catalog objects, locations, states, and time ranges, making it id…
Untrusted display-only summary
SQUARE_RETRIEVE_LOCATION
Tool 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 information, and capabilities.
Untrusted display-only summary
SQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTE
Retrieves 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-defined information.
Untrusted display-only summary
SQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION
Tool 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.
Untrusted display-only summary
SQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTE
Retrieves 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-defined information.
Untrusted display-only summary
SQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION
Tool 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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.