Squareup is the Square payments API platform used to access Square commerce, payment, customer, and order data.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Squareup

Squareup is the Square payments API platform used to access Square commerce, payment, customer, and order data.

Base URL: https://connect.squareup.com
Auth: header:Authorization (pass your key via the apiKey input)

Operations

listemployees — GET /v1/me/employees — ListEmployees
retrieveemployee — GET /v1/me/employees/{employee_id} — RetrieveEmployee
listemployeeroles — GET /v1/me/roles — ListEmployeeRoles
retrieveemployeerole — GET /v1/me/roles/{role_id} — RetrieveEmployeeRole
listorders — GET /v1/{location_id}/orders — ListOrders
retrieveorder — GET /v1/{location_id}/orders/{order_id} — RetrieveOrder

Inputs

apiKey — your squareup API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: listemployees
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: listemployees, retrieveemployee, listemployeeroles, retrieveemployeerole, listorders, retrieveorder
`employee_id`	string	no	—	Path parameter employee_id (required by some operations).
`location_id`	string	no	—	Path parameter location_id (required by some operations).
`order_id`	string	no	—	Path parameter order_id (required by some operations).
`role_id`	string	no	—	Path parameter role_id (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.