Skip to content

Training Explore the GraphQL API

Craig Scott edited this page Jun 9, 2026 · 1 revision

Training: Explore the GraphQL API

What you'll learn: how to discover and run GraphQL queries against your application's API. You need: Administrator or Developer access type, any application. Time: 5 minutes.

Steps

  1. Go to Left menu → Schema & GraphQL → GraphQL API Explorer. (Fallback: header Search "API Explorer".) API Explorer
  2. Browse the Documentation Explorer on the left: Root Types Query and Mutation list every generated operation; the search box filters by name.
  3. The editor pre-loads an example (query DataFlows). Click ▶ to run it.
  4. Read the Result pane — a fresh application returns empty edges: Query result
  5. Edit the query (the editor offers type-ahead aware of the schema and highlights validation errors), then run again.
  6. Use the Variables panel for parameterized queries; History recalls previous runs.

Check your work

You can find a model's query in the Documentation Explorer, run it, and read JSON results. Deployed data models appear here automatically with generated types.

To keep a query for reuse (exports, flows, screens), save it under Schema & GraphQL → Saved Queries.

Try it yourself

Search the Documentation Explorer for user, build a query returning user emails, and run it.

Related training

Training: Create a Data Model · Training: Export Data

🏠 Home

Getting Started (14)
Training Guides (52)

Applications

Access & Users

Data Models & Schema

Screens

Weather Lookup Series — guided 3-part build

Data Flows & Integrations

Data, Reporting & Monitoring

Enterprise & Organizations

Platform Concepts & Architecture (10)
Screens & Application Design (17)
Data Models & Schema (8)
Data Flows & Scripting (51)

Designing Flows

Data Flow Nodes

JSONata Reference

Scripting

Integrations & Connectors (30)

General & iPaaS

Plex

EDI

IIoT & Edge Gateway (18)

Physical Device Connectors

Edge Data Connectors

Reporting, Documents & Dashboards (8)
Administration & Access Control (27)
Data Management (8)
Accelerators, Templates & Packages (8)
Design Standards (1)
How-To Guides (8)
FAQ & Troubleshooting (1)
Release Notes (117)

2026

2025

2024

2023

2022

2021

2020

Policies & Company (6)

Clone this wiki locally