Skip to main content

​
GraphQL Introduction

Powerful GraphQL API for flexible server management and real-time data querying
The Filed GraphQL API provides a flexible, efficient way to query and manage your taxpreps. Unlike REST APIs, GraphQL allows you to request exactly the data you need in a single request, reducing over-fetching and improving performance.

​
Key Features

  • Flexible Queries: Request only the data you need
  • Type Safety: Strongly typed schema with comprehensive documentation
  • Single Endpoint: All operations through one GraphQL endpoint

​
Getting Started

​
Endpoint

https://gateway.filed.com/graphql

​
Authentication

All GraphQL requests require authentication using a Bearer token in the Authorization header and a source-platform header to identify your integration. The source-platform header is required for all requests, including the initial login request. 
Authorization: Bearer YOUR_JWT_ACCESS_TOKEN
source-platform: your-platform-name
The source-platform header should be a custom identifier for your integration, such as:
  • A tax firm name: tax-firm-a
  • A partner name: my-sample-platform, qount, etc.
  • Any identifier that helps identify your platform
The source-platform header is used to uniquely identify API requests for analytical purposes. This helps Filed track usage patterns and provide better support for your integration. The header does not affect rate limits or any other API functionality.

​
Basic Query Example

query GetHealthResponse {
  health {
    api
  }
}

​
Schema Overview

The main types in the GraphQL schema:
  • Workspaces: Query and manage your workspaces
  • User: Access current logged in user details
  • TaxPrep: Query and manage your taxpreps
  • InputDocument: Query and manage the documents you submitted for taxprep

​
GraphQL desktop client

Explore the GraphQL API interactively using a desktop client:

GraphQL desktop client

Test queries with this desktop client (Httpie)

​
Benefits Over REST

Fetch multiple related resources in a single request instead of multiple REST calls.
Request only the fields you need, reducing payload size and improving performance.
Strongly typed schema prevents runtime errors and improves developer experience.

​
Next Steps

  • Customer integration guide: Check out our Customer integration guide to learn how to integrate Filed’s API as a customer.
  • Partner integration guide: Check out our Partner integration guide to learn how to onboard and integrate your tax firm customers.
  • API reference: Check out our API reference to learn about the available endpoints and how to use them.