Skip to main content

๐Ÿ”Œ How to use the Kraaft API

Kraaft makes it easy to connect your workspace to your other tools and automate your workflows: no more double entry, just smart connections ๐Ÿ’ก

A few concrete examples โฌ‡๏ธ

  • ๐Ÿ—๏ธ Automatically create a Kraaft conversation from your ERP when a project kicks off

  • ๐Ÿ“‚ Archive your reports in SharePoint, Google Drive or your DMS as soon as theyโ€™re completed

  • ๐Ÿ”” Trigger an action in an external tool as soon as a reportโ€™s status changes in Kraaft

  • ๐Ÿ’ฌ Automatically send a message or photo in a conversation from a third-party tool

  • ๐Ÿ“… Retrieve the messages of a conversation to feed your site planning


โ˜‘๏ธ Step 1: Activate the API on your Kraaft workspace

The Kraaft API isnโ€™t activated by default โš™๏ธ To get it, contact our support.

โš ๏ธ Only an account owner can request activation.


๐Ÿ”‘ Step 2: Create a Kraaft API key

Once the API is activated, the workspace admin or owner can create keys from the settings ๐Ÿ› ๏ธ

  1. Go to the Menu โ†’ Settings of your workspace

  2. Click the API Keys tab ๐Ÿ”‘

  3. Click "Create an API key" โž•

  4. Give it a clear name (e.g. "Make - ERP" or "Zapier - Archiving") ๐Ÿ“‹

  5. Choose the keyโ€™s role

๐Ÿ’ก An API keyโ€™s permissions follow the exact same roles as in Kraaft: External, Standard, Administrator and Owner ๐Ÿ‘ค Each role gives access to a different scope of your conversations and reports โ€” we cover the details of each role in our article "Going further with the Kraaft API", to help you pick the right one for your use case.

โš ๏ธ The key is only shown once โ€” copy it right away! If you lose it, youโ€™ll need to create a new one (takes 2 minutes, but better to avoid it ๐Ÿ˜…)

๐Ÿ” Building an app where each user connects their own Kraaft account? The API also supports OAuth 2.0, in addition to API keys


๐Ÿ“ฆ What you can do with the Kraaft API today

The Kraaft API gives you access to 6 resources ๐Ÿ—‚๏ธ

  • ๐Ÿ—‚๏ธ Workspaces โ€” list the workspaces accessible with your key

  • ๐Ÿ“‹ Schemas โ€” read the structure of your reports to know what to send and receive

  • ๐Ÿ“ Records โ€” list, read, create and update your reports

  • ๐Ÿ’ฌ Conversations โ€” read, create, archive a conversation and manage its members

  • ๐Ÿ“จ Messages โ€” send messages and files (photos, documents) into a conversation, and read the message history

  • โšก Events โ€” detect in real time everything happening on your reports and messages

โšก Zoom on Events

Kraaft keeps a log of everything that happens ๐Ÿ”” Every report created, updated, deleted or restored and every message sent, edited or deleted generates an event. Two ways to consume them:

  • List of events โ€” poll Kraaft at regular intervals ("what happened since last time?")

  • Real-time events โ€” get events instantly, as soon as they happen โšก

Example: your ERP gets notified automatically as soon as a report moves to "Done" status in Kraaft, or your planning picks up every new piece of info posted in a site conversation โšก


๐Ÿค– Using the Kraaft API with an automation tool

Want to connect the Kraaft API to a no-code tool? Absolutely possible ๐ŸŽ‰

  • โœ… Make โ€” install the Kraaft app directly from make.kraaft.co: you connect via OAuth, in one click, no need to copy a key by hand

  • ๐Ÿ”ง n8n, Zapier and others โ€” use your tool's HTTP or API request modules to call the Kraaft API with your key


๐Ÿ“– Accessing the Kraaft API documentation

The official documentation is available here ๐Ÿ‘‰ developers.kraaft.co

It covers every available endpoint, the expected data formats and the authentication methods ๐Ÿ“š A technical profile will get up to speed quickly!


๐Ÿ“Š Want to analyze your Kraaft data?

Kraaft Data Exchange (KDE) is made for that ๐Ÿ“Š Connect your data to Power BI, Tableau or Looker โ€” and manage your projects from a single data visualization tool.

๐Ÿ‘‰ Discover KDE


๐Ÿง  Want to use Kraaft from an AI assistant?

The API is built to connect tools together, automatically ๐Ÿ”ง To ask questions about your Kraaft data or request an action in plain language from Claude, ChatGPT or another AI assistant, use the Kraaft MCP instead ๐Ÿค–


๐Ÿ” Want to go further?

Reading the messages of a conversation, API key or OAuth, key roles in detail, resolving IDs, lists and tables, filtering and real timeโ€ฆ we've gathered every subtlety of the API in a companion article ๐Ÿ•ต๏ธ


๐Ÿ“ž Need help?

If you have any questions, Contact us!

Did this answer your question?