Skip to main content

About the GraphQL Content API

The GraphQL Content API can be used to Fetch, Create, Modify and Delete data in the platform.

Overview

Here are some quick links to get you up and running with the GraphQL Content API:

About GraphQL

The GraphQL data query language is:

  • A specification. The specification determines the validity of the schema on the API server. The schema determines the validity of client calls.

  • Strongly typed. The schema defines an API’s type system and all object relationships.

  • Introspective. A client can query the schema for details about the schema.

  • Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query and receive only the data you specify in a single round trip.

  • GraphQL works at the application layer and is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

Root endpoint

The GraphQL Content API has a single endpoint.

https://developer.swapcard.com/event-admin/graphql

The GraphQL Content API endpoint remains constant no matter what operation you perform.

Why Swapcard is using GraphQL

Swapcard is using GraphQL for the following reasons:

  • The ability to request exactly the data you need.
  • A self describing schema exposing the different API's capabilities.
  • Strongly typed system preventing typo or invalid input data, so you are sure about the format and type of the data you are requesting and sending.
  • Multiple programming languages support, GraphQL being widely adopted across the industry with pre-built libraries
  • Easy to understand and migrate from a classic REST API model.