Skip to content
GraphQL Requests

GraphQL Requests

A GraphQL request sends a query or mutation to a GraphQL endpoint. Create one from New › GraphQL request above the request tree, or right-click a collection and choose New GraphQL request.

The request bar

ControlWhat it does
URLThe GraphQL endpoint, for example https://api.example.com/graphql. {{variables}} work here. Press Enter in the field to send.
SendSends the request (⌘Enter).
SaveSaves the request (⌘S). Enabled when there are unsaved changes.

Chapar sends the request as a POST with a JSON body, {"query": …, "variables": …}, and Content-Type: application/json, which every GraphQL server accepts.

Query

Write the query or mutation on the Query tab:

query Launches($limit: Int) {
  launches(limit: $limit) {
    id
    mission_name
  }
}

{{variables}} and functions are filled in before the request is sent, and the editor completes them as you type.

Variables

The Variables tab holds the GraphQL variables as a JSON object, for example {"limit": 5}. It is a JSON editor, so it formats, highlights and checks the JSON. Leave it as {} to send no variables; invalid JSON stops the request with an error that says so.

Environment {{variables}} work inside the JSON too, so {"userId": "{{userId}}"} takes the value from the active environment.

Headers, Auth, Actions and Info

These tabs work the same as for HTTP requests:

TabWhat it does
HeadersExtra headers, each with a checkbox to turn it off. Headers set on the request’s collection are sent too.
AuthInherit (use the collection’s auth), None, Bearer, Basic or API Key.
ActionsPre-request and post-request actions: run a request or a Python script first, and set environment values from the response.
InfoThe request’s name and description. A request without a name is listed by its URL.

The response

The line at the top of the response pane shows the status code, the time the request took and the size of the body.

TabShows
ResponseThe JSON the server returned, formatted and highlighted. Check Raw to see it exactly as received. Right-click for Copy and Save….
HeadersThe headers sent and the headers the server returned.
CookiesCookies the response set and the cookies sent from the jar. See Cookies.
TimelineEvery step of the request on one time scale: actions, DNS lookup, connect, TLS, sending, waiting and download.

GraphQL servers usually answer 200 even when a query fails, with the problem in the body’s errors array, so check the body as well as the status.