GraphQL Introduction
Powerful GraphQL API for flexible server management and real-time data queryingThe 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
Authentication
All GraphQL requests require authentication using a Bearer token in the Authorization header.Basic Query Example
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
Reduced Network Requests
Reduced Network Requests
Fetch multiple related resources in a single request instead of multiple REST calls.
Client-Specified Data
Client-Specified Data
Request only the fields you need, reducing payload size and improving
performance.
Type Safety
Type Safety
Strongly typed schema prevents runtime errors and improves developer experience.
Next steps
- Authentication: Create an API key and exchange it for an access token in the Authentication guide.
- Quickstart: Go from zero to a processed client in five steps in the Quickstart.
- Making requests: Learn the request shape, variables, and the error model in Making requests.
- Uploading documents: Stage files through the resumable upload endpoint and attach them to a client in the Uploading documents guide.
- API reference: Browse the operations,
health,me, Clients, Tasks, and Conventions, in the API reference.
Looking for the previous REST API? It is preserved under Legacy.