Getting Started

What is GraphQL?

GraphQL is a query language and a runtime system. Clients form requests (called queries and mutations) by using the GraphQL query language, and the GraphQL server executes the request and returns the data in a response. Unlike REST APIs, which expose a different endpoint for each resource object, a GraphQL API makes all data available at a single endpoint. A client specifies exactly the data that it wants, and the server responds with only that data.

GraphQL looks similar to JSON. The following example shows a simple GraphQL query and the JSON response:

query {
  member(username: "admin") {
    id
    name
    username
    tagline
  }
}

JSON Response

{
  "data": {
    "member": {
      "id": "2KONsPORsA",
      "name": "Siavash",
      "username": "admin",
      "tagline": "CEO at Bettermode"
    }
  }
}

GraphQL Endpoint

All GraphQL requests should be sent as a POST request to the following address for the US region (us-east-1):

https://api.bettermode.com

You can access Bettermode's GraphQL playground from the same address as well.

info

If your community is in the EU region (eu-central-1), you should use the following GraphQL endpoint instead:

https://api.bettermode.de

The GraphQL API playground for the EU region is available here.

note

All requests to Bettermode's GraphQL endpoint should be authenticated using App Access Token or Bettermode Access Token.