Hoppscotch · GraphQL Specification

Hoppscotch GraphQL API

The Hoppscotch backend exposes a GraphQL API used by the web, desktop, and CLI clients for team collaboration, personal workspaces, and infrastructure management in self-hosted deployments. The API covers user authentication sessions, team management, shared request collections, environments, request history, shortcodes (shared request links), mock servers, and published API documentation. Admin/infra operations are available to administrators for managing users, SSO providers, SMTP configuration, and infrastructure tokens.

Documentation Endpoint View on GitHub API TestingClientsGraphQLOpen SourcePlatformRESTWebSocketsGraphQL

Overview

Hoppscotch GraphQL API is a GraphQL API specification published by Hoppscotch on the APIs.io network.

The Hoppscotch backend exposes a GraphQL API used by the web, desktop, and CLI clients for team collaboration, personal workspaces, and infrastructure management in self-hosted deployments. The API covers user authentication sessions, team management, shared request collections, environments, request history, shortcodes (shared request links), mock servers, and published API documentation. Admin/infra operations are available to administrators for managing users, SSO providers, SMTP configuration, and infrastructure tokens.

The GraphQL endpoint is available at https://{your-hoppscotch-backend}/graphql. documentation is published at https://docs.hoppscotch.io.

The specification includes 4 reference links.

Tagged areas include API Testing, Clients, Open Source, Platform, and REST.

Endpoint

https://{your-hoppscotch-backend}/graphql

References

Back to Hoppscotch · All GraphQL Specs · GitHub