Toggle Developers
HomeAcademy
  • Welcome
  • GraphQL
    • Getting started
    • Exploring our API
    • Authentication
    • API playground
    • Error handling
  • Key concepts
    • Overview
      • Orders, Transactions & Line Items
      • Card number formats
  • Basics
    • Create a card
    • Check a card balance
    • Redeem a card
  • Webhooks
    • Overview
      • Getting started
      • Authentication & responses
    • Events
      • Card.balance_adjusted
      • Card.card_reference_updated
      • Card.expiry_reminder
      • Card.registered
      • Card.send_recipient_email
      • Card.resend_recipient_email
      • Order.created
      • Order.cancelled
      • Order.send_receipt_email
      • Order.send_cancellation_email
      • Payment.failed
      • Payment.review_opened
      • Fulfilment.dispatched
  • Partner Guides
    • EPOS & Ordering
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Physical card orders
      • Custom validity rules
      • Balance check
      • Redemptions & top-ups
      • Reversals
    • Guest gratuity
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Creating a card
      • Cancelling a card
      • Register a card
    • CRM
      • Overview
      • Historic data via GraphQL
      • Real time data via webhooks
Powered by GitBook
On this page
  • API Explorer
  1. GraphQL

Exploring our API

We have an API explorer and playground.

PreviousGetting startedNextAuthentication

Last updated 16 days ago

API Explorer

We have an API explorer (GraphiQL) where you can start to explore our queries and mutations.

Our API explorer:

Queries

You can (follow the link and click the ▶ button).

Schema

You can also defined in our schema.

Types

To drill down to details about any type, pass in the name of the type, for example:

query {
  __type(name: "Card") {
    name
    kind
    description
    fields {
      name
    }
  }
}

The explorer is useful while you are discovering our public queries without any authentication.

Note that the introspection query is the only GET request you’ll run in GraphQL. If you’re passing a body, the GraphQL request method is POST, whether it’s a query or a mutation.

https://api.mytoggle.io/graphiql
show all available queries
list all types