Skip to main content

Communicating with GraphQL

Because GraphQL operations consist of multiline JSON, Switchy recommends using a graphQL Softwair Client like Altair to make GraphQL calls. You can also use cURL or any other HTTP-speaking library.

In REST, HTTP verbs determine the operation performed. In GraphQL, you'll provide a JSON-encoded body whether you're performing a query or a mutation, so the HTTP verb is POST. The exception is an introspection query, which is a simple GET to the endpoint.

To query GraphQL using cURL, make a POST request with a JSON payload. The payload must contain a string called query:

curl -H "Api-Authorization: your-token" -X POST -d " \
{ \
\"query\": \"query { workspaces { companyName createdDate id name }}\" \
} \

Note The string value of "query" must escape newline characters or the schema will not parse it correctly. For the POST body, use outer double quotes and escaped inner double quotes.