GraphQL Management API reference

In this section you will find information about all the queries and mutations that are available, together with their associated input and output objects. The GraphQL playground makes it easier to build and test queries and can be used as a starting point.

For getting started, authentication, conventions, rate limits, asset search syntax, and worked examples, see the overview section.

Schema introspection

The complete GraphQL schema can be fetched directly from the API using an introspection query. This is the most reliable way for AI coding tools, GraphQL clients, and code generators to consume the schema.

To fetch the schema, paste the following introspection query into the API Playground (log in with Single Sign-On) or any GraphQL client, run it, and save the full JSON response.

The JSON response contains the complete type system: all queries, mutations, objects, inputs, enums, interfaces, unions, scalars, and directives, including descriptions and deprecation notices.

Full introspection query

{
  __schema {
    queryType { name }
    mutationType { name }
    subscriptionType { name }
    types {
      ...FullType
    }
    directives {
      name
      description
      locations
      args {
        ...InputValue
      }
    }
  }
}
fragment FullType on __Type {
  kind
  name
  description
  fields(includeDeprecated: true) {
    name
    description
    args { ...InputValue }
    type { ...TypeRef }
    isDeprecated
    deprecationReason
  }
  inputFields { ...InputValue }
  interfaces { ...TypeRef }
  enumValues(includeDeprecated: true) {
    name
    description
    isDeprecated
    deprecationReason
  }
  possibleTypes { ...TypeRef }
}
fragment InputValue on __InputValue {
  name
  description
  type { ...TypeRef }
  defaultValue
}
fragment TypeRef on __Type {
  kind
  name
  ofType {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}

Reference

Queries

Use a GraphQL query when you need to retrieve data from the server.

Mutations

Use a GraphQL mutation to perform any operation that changes data on the server.

Objects

GraphQL objects represent the different kinds of resources you can access using this API.

Interfaces

Interfaces define shared fields that are common across multiple object types.

Enums

Enums define a fixed set of allowed values for a field.

Inputs

Input types are passed as arguments to mutations and some queries.

Scalars

Scalars are primitive value types used throughout the schema.

Unions

Union types can be one of several concrete object types.

Directives

Directives control execution behavior and annotate schema elements.