Introduction

Our GraphQL endpoint provides a comprehensive dataset comprising essential information, including unique IDs and metadata associated with your service account. This resource allows you to query details such as the funds associated with your account, supported import and export templates for each fund, and details about subscription contacts and their status. Please note that our GraphQL API currently does not support mutation or subscription operations. To perform actions, follow the best practice of retrieving necessary IDs through GraphQL queries and then triggering specific REST API calls. For example, to download documents for a subscription, initiate a GraphQL query to obtain the list of file IDs and then use the obtained IDs to generate a download URL through a dedicated 'get download URL' API request

The GraphQL API employs the same authentication protocol as our REST API. Ensure the inclusion of the authentication header containing your API key in each request.

Schema

Explore our GraphQL schema on this page.

Playground

Get yourself familiar with our GraphQL using this GraphQL Plaground.

Other Notes

Each GraphQL query is subject to complexity validation, in addition to the rate limit applied to your API key. A comprehensive explanation of the complexity validation process can be found here.