GraphQL API (in Alpha)

You’ve been asking and we’ve been listening. We are very pleased to announce that we have released a new GraphQL API, and it is publicly available to all developers as part of an early alpha release. Using GraphQL, you can query multiple objects from different Square APIs.

The following Square APIs are supported for this alpha release:

  • Orders
  • Catalog
  • Customers
  • Merchants

Features of our GraphQL API include:

  • A single GraphQL endpoint that covers multiple Square APIs – no need for sleepy REST calls.
  • The ability to work with your existing data, existing Sandbox, and existing OAuth credentials.
  • Standards Compliant GraphQL schemas that enable developer tooling
  • The ability to query for exactly the data you need, including multiple kinds of data with one query.
  • GraphQL Explorer

During this alpha release, we are working hard to gather feedback to improve our developer experience. Square GraphQL may be subject to breaking changes to the schema and the list of supported APIs that are backwards incompatible with future releases.

We also anticipate changes to the GraphQL Explorer and documentation during the alpha release. Queries to Square GraphQL (alpha) are rate limited to 2 queries per second (learn more about Rate Limiting here), which might make it not suitable for use in a production environment.

2 Likes