Reference

Schema Documentation

Our schema documentation lists all the content of our GraphQL API's schema. So you'll find all the queries and mutation that are available, as well as a description of the types manipulated by the API.

Do note that Apollo offers the same capabilities, but where Apollo requires to be authenticated with a valid iAdvize account, the static documentation is available and shareable publicly.

Read our Schema Documentation

Apollo

You can discover the schema and run queries on your iAdvize data using Apollo, an integrated development environment in your browser that includes the schema description, syntax highlighting, and validation errors.

Experiment with our GraphQL API

Using Apollo

Authentication

You'll need to be authenticated in order to test queries. If you weren't already, you'll automatically be prompted to sign-in when reaching the Apollo page, after which you'll be able to continue using the query editor.

You can test your access by querying your projects:

query {
  projects {
    edges {
      node {
        id
        name
      }
    }
  }
}

Test this query in our editor

Using the query variables pane

If you want to learn more about variables in GraphQL you can read this documentation: https://graphql.org/learn/queries/#variables

Discovering iAdvize GraphQL API

Since graphQL is introspective, it means you can query a GraphQL schema for details about itself.

Query __schema to list all types defined in the schema and get details about each:

query {
  __schema {
    types {
      name
      kind
      description
      fields {
        name
      }
    }
  }
}

Query __type to get details about any type:

query {
  __type(name: "Conversation") {
    name
    kind
    description
    fields {
      name
    }
  }
}