Links

API

Blue has an API (Application Programming Interface), so you can build your own integrations if required.
Blue has 100% API coverage. This means that anything that you can do in any of our apps, you can do programmatically. We have a powerful GraphQL API that has a full playground where you can test your queries and is fully documented.
You can try the playground here:
The Blue API Playground where you can test your queries
We have also made a video tutorial that explains how you can leverage the Blue API.

Generate a Token

To start using our API, click on your profile on the top right, and under the profile menu, you'll find the API tab.
In the API tab, click on the button "Generate a Token":
Provide a name for the token and set an expiration date if desired. If you set an expiration date, the API token will automatically stop working after that date.
After generation, you'll receive a Token ID and a Secret ID. The Token ID is your unique identifier for API access, while the Secret ID acts as a password, ensuring secure communication with Blue's API. Remember, the Secret ID is shown only once for security reasons, so store it safely to maintain access to your data through the API.
The Security Token is only shown once, so make sure you save it securely.
Security Warning
Ensure you keep your Token ID and Secret ID secure, as anyone with access to these credentials can access your data in Blue.
You have now successfully generated an API token developers can use for custom integrations into Blue.

API Playground

Blue offers an API Playground to experiment with and test your API queries.
  1. 1.
    Interactive Environment: The Blue API Playground provides a user-friendly interface where you can easily compose and execute GraphQL queries and mutations. It's designed to help developers interact with the GraphQL API without the need for additional tools or writing frontend code.
  2. 2.
    Real-time Testing and Debugging: One of the key features of the Blue API Playground is the ability to test queries and mutations in real-time. You can write a query or mutation, execute it, and immediately see the response from the server. This immediate feedback is invaluable for debugging and optimizing your queries.
  3. 3.
    Introspection: Blue's APIs are self-documenting. The Playground leverages this by providing an introspection system. This system allows you to explore the types of data available in the API, including queries, mutations, and the structure of data objects. It's a great way to understand the capabilities of the API and the relationships between different data types.
  4. 4.
    Documentation Explorer: Blue's API Playground includes a built-in documentation explorer. This section provides detailed information about the schema, including descriptions of types, queries, mutations, and other relevant details. It's a handy reference guide for developers at all levels.
  5. 5.
    Headers and Variables Support: The Playground allows you to manage HTTP headers and variables easily. This is particularly useful for handling authentication tokens and other configuration details required to interact with the Blue API.
  6. 6.
    Multi-Tab Interface: Thanks to a tabbed interface, you can simultaneously work with multiple queries or mutations. This makes it easier to manage different aspects of your API interactions simultaneously.
  7. 7.
    Query History: Blue's API Playground keeps a history of your queries so that you can revisit and re-run past queries. This feature can be a significant time-saver during development and testing.
After generating your token, use the ▶️ button to enter the playground:
Press ▶️ to enter the API Playground
Next, you will have to enter your Secret Key, alongside the CompanyID and ProjectID:
Add your details under HTTP Headers
To find your CompanyID and ProjectID, you can check the URL of any project you can access. Both IDs are within the URL, as shown below:
https://app.blue.cc/company/{CompanyID}/projects/{ProjectID}/todo

API Documentation

Blue's APIs are self-documenting based on your custom data structure.
The API documentation and schema are seamlessly integrated within the playground, conveniently on the right side. This feature enables users to access comprehensive information about the API's capabilities, including available queries and mutations. A search function is provided for enhanced usability, allowing for quick and efficient query lookup. Users can also download the schema in JSON or SDL formats, facilitating offline reference and further analysis. This integration of documentation within the playground aims to provide developers a comprehensive and user-friendly experience.
The Blue API Documentation is build right into the playground
Need more help?
Feel free to reach out to our team at [email protected] for assistance. We also offer professional services for custom integrations.