---

The Blue API is a powerful tool that allows you to interact with Blue's data and functionality programmatically. Here are some of the capabilities you can achieve with the Blue API:

The Blue API offers a range of powerful capabilities that enable you to interact with Blue's data and functionality programmatically.

Let's explore these capabilities in more detail.

Read Data

The API allows you to fetch specific data in a single query using a flexible and precise schema. This means you can request exactly the information you need, from simple data points to complex nested structures, all in one efficient query. This capability is particularly useful when you need to retrieve data from multiple related entities without making multiple API calls.

Write Data

With the Blue API, you can modify data on the server using mutations. These mutations allow you to create new records, update existing ones, or delete data as needed. This gives you full control over the data in your Blue instance, enabling you to automate processes or integrate Blue with other systems in your workflow.

For bulk operations, the API provides specific mutations like createCustomFieldOptions, deleteFiles, and uploadFiles. While general bulk create/update operations for all entities are not available, you can efficiently process multiple operations by sending multiple mutations in a single GraphQL request.

Real-Time Update

One of the most powerful features of the Blue API is its support for subscriptions. This allows clients to listen to data changes in real-time without the need for constant polling. You can set up subscriptions to be notified immediately when certain data changes, enabling you to build responsive applications that always display the most up-to-date information.

Efficient Data Fetching

The API is designed to reduce over-fetching of data. Unlike traditional REST APIs where you might receive more data than you need, with the Blue API, you can specify exactly which fields you want to retrieve. This not only reduces the amount of data transferred over the network but also improves the performance of your applications by minimizing the processing of unnecessary data.

The API includes query depth limiting (maximum 10 levels) to prevent performance issues and potential abuse from excessively nested queries. This ensures optimal performance while still allowing complex data retrieval.

Schema Introspection

The Blue API provides the ability to discover and explore its capabilities dynamically. This means you can query the API itself to understand what queries, mutations, and types are available. This feature is incredibly useful for developers, as it allows for easy exploration of the API's capabilities and helps in building robust, future-proof integrations.