v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451205197.1 KB

Retrieves the introspection schema for a GraphQL API.

get/v1/apis/{apiId}/schema#format

Path parameters

apiIdstring required

The API ID.

Query parameters

format'SDL' | 'JSON' required

The schema format: SDL or JSON.

includeDirectivesboolean

A flag that specifies whether the schema introspection should contain directives.

Response

Success

schemastring
<p>The schema, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL documentation</a>.</p>