graphsql Documentation

All you could ever need to know about GraphSQL and how to get started

Introduction

GraphSQL is an extension for Salesforce that allows you to send GraphQL queries to the Salesforce API. This allows you to benefit from a lot of the cool features that GraphQL has, as well as letting you query multiple objects and relationships with the same API call, meaning you can make your integrations much more efficient and cost effective. Using Mutations you can create or update multiple records in one go, meaning an entire family of records can be inserted with just one API call.

Add in GraphQL to your integrations to make them more efficient

GraphSQL Playground

With the GraphSQL Playground, you can test out GraphQL queries and get back not only the GraphQL JSON response you'd expect, but also a list of the queries or mutations that were run to get the data, so you can check that your arguments are being passed in correctly, and see how things are being run under the hood.

GraphSQL Endpoint

The main feature of GraphSQL is a new API endpoint that is added to your Salesforce instance. This custom REST API endpoint can be found at

https://instance.salesforce.com/services/apexrest/aptk_graphql/graphql

. This is the same endpoint that is used by the playground, so if it's working there you'll know it'll work in your code.

If you're making requests to this endpoint, make sure you've whitelisted your requesting domains in Setup -> CORS

If you're ready, let's get stuck in!