GraphQL Introduction

GraphQL lets you request exactly the data you need from your Instance, nothing more and nothing less. The GraphQL section in the API module shows all GraphQL queries and mutations deployed to your Instance, giving you a central place to view, manage, and organize them.

How GraphQL Queries Get Here

GraphQL queries are typically created by developers as .graphql files in the project codebase. Using the Insites CLI tool, these files are deployed to your Instance where they become available for use in your application. Once deployed, they appear here in the GraphQL section.

You can also create and edit queries directly in the admin. This is useful for quick additions or adjustments without going through the full development and deployment cycle.

What You Can Do

• View all GraphQL queries and mutations deployed to your Instance
• Search and browse queries by display name or system name
• Create new queries directly in the admin
• Edit existing query definitions
• Delete queries you no longer need

How Queries Are Organized

Each query has three key parts:

• Display Name - What you see in the admin list view (the human-readable label)
• Name - The system identifier derived from the file path. This is the name used when calling the query from Liquid templates.
• Body - The actual GraphQL query or mutation code

The list view shows all queries with their display name, system name (file path), creation date, last updated date, and status. You can search by display name or system name to find a specific query.

Next Steps

• Creating a GraphQL Query
• Managing GraphQL Queries