Awell wants the GraphQL API to be the primary means of interacting programmatically with Awell. GraphQL is a query language for APIs.
In GraphQL, queries and mutations are the two types of operations that can be performed on a GraphQL API.
Awell's GraphQL Schema outlines which objects and fields are available for clients to query and their corresponding data types.
If you are new to GraphQL, we advise you to have a look at some of the resources below to get acquainted with the concepts around it:
Explore our GraphQL API using the interactive GraphiQL explorer.
The Awell GraphQL API is versionless and changes to the API are primarily backward-compatible.
However, Awell might sometimes change the GraphQL API in a way that is not backward-compatible. These changes are considered breaking changes, and can include removing or renaming fields, arguments, or other parts of the schema. When creating a breaking change, Awell follows a deprecation and removal process (coming soon).
To avoid having a breaking change affect your integrations, you should familiarize yourself with the deprecation and removal process and frequently verify your API calls against the future breaking-change schema.