GraphQL Guide

The GraphQL API gives you insight into your account and the objects it owns, allow you to create, update, start, and submit data to both Workflows Etch e-sign packets.

First check out the API getting started article to learn how to get an API key and use it to authenticate to the API. Additionally, brushing up on our terminology will be helpful in understanding the queries below.

GraphQL reference

This guide will help you get started using common queries and mutations. For a complete list of queries, mutations, and types see the GraphQL reference.

Postman collection

To get you and running with the GraphQL API without writing code, see the examples in our GraphQL Postman collection:

For more information on using the Postman workspace, see our Postman workspace guide.

API clients

We have created Node.js, Python, and C#/.NET API clients to help our users interact with our API more easily. They help to simplify:

• Authentication
• Common GraphQL calls
• Raw REST and GraphQL calls
• GraphQL calls involving binary file uploads

Your first query

All queries are POSTs to a single URL: https://graphql.useanvil.com.

A good place to start is with the currentUser query. This query will return your API user with all the main objects (etchPackets: Etch e-sign packets, casts: PDF templates, welds: Workflows, and forges: Webforms) on your account.

# POST https://graphql.useanvil.com
{
  currentUser {
    eid
    organizations {
      eid
      name
      slug

      # All of your PDF templates are Cast objects
      casts {
        eid
        name
      }

      # All of your e-sign packets
      etchPackets {
        rowCount
        pageCount
        page
        pageSize
        items {
          eid
          name
          isTest
          status
          detailsURL
        }
      }

      # All of your workflows are Weld objects
      welds {
        eid
        name
        forges {
          eid
          name
        }
      }
    }
  }
}

Workflow queries & mutations

See the workflows API guide for comprehensive docs.

E-Signature queries & mutations

See the e-signature API guide for comprehensive docs.

GraphQL schema SDL

You can download the entire Anvil GraphQL schema by making a GET request to https://app.useanvil.com/graphql/sdl. Note that you must be logged in to Anvil in order to access our GraphQL schema. You can be logged in as a normal user or you can authenticate with your API key.