How to set up API access to FYI
FYI (FYI Docs) does not let you self-generate an API key from inside the app the way many tools do. API access is approval-gated: you, or the developer or tool acting for you, apply to FYI, build against a staging account first, then request production credentials and agree to FYI's terms before going live. Once granted, the credential is an API key that lets a connected tool read your FYI document, client, and job data through FYI's external API. It can be revoked again at any time, and FYI controls the approval, so it is the safest path to a programmatic connection. This guide explains the application path and who handles each part, with links to the official FYI dev portal so the right person can start the request.
Keep this credential safe
A FYI API key is like a password: anyone who has it can access the data the key allows, with no further login. Only request the access the connection genuinely needs, and where FYI lets you, keep it read-only. Share the key through a secure method such as a password-manager share link, never plaintext email or chat. Store it somewhere safe, and delete or rotate it as soon as the developer or tool no longer needs it.
Access to grant
A FYI external API key (custom application key, or an app integration key), scoped to your FYI account and approved by FYI before production use.
Who you're granting access to
- The developer, consultant, or tool that will read your FYI data through the API.
Before you start
- An admin user on your FYI account, so you can authorise an integration and confirm who may connect.
- The name of the developer, consultant, or tool that will read your FYI data, and what it needs to do.
- A staging (preprod) FYI account to build and test against before any production credentials are issued.
Step by step
- 1
Read the FYI dev portal and decide who will apply
Open the official FYI developer documentation at https://developers.fyi.app to confirm the current process and which access type fits. If a single in-house tool or one developer will connect, that is the "Custom Application" path. If you are building an integration for many FYI customers, that is the app path. In most cases your developer or implementer lodges the request on your behalf with your authorisation.
- 2
Set up a staging account and request integration keys
FYI requires you to build against a staging (preprod) account first. Create one at https://preprod.fyi.app, then email developers@fyi.app from the address used to create it and ask to set up an integration (or to enable the Custom Applications feature). FYI then issues custom keys that grant access to the staging API so the integration can be built and tested.
- 3
Build and test against the staging API
Your developer or tool connects to the FYI staging external API using the issued keys and confirms it can read the data it needs. Keep these staging keys private and treat them like a password: only the people building the integration should hold them.
- 4
Request production credentials and sign the agreement
When the integration is ready, email api@fyi.app to request production credentials. FYI requires you to agree to its terms and conditions, sign an agreement, and demonstrate the integration before issuing production keys. Once approved, copy the production API key into a secure location and share it only through a secure method.
Removing access afterwards
- If FYI enabled the Custom Applications feature for your account, sign in as an admin, open Custom Applications, find the key, and delete or regenerate it. Regenerating immediately invalidates the old key.
- For an app-based or production integration, email developers@fyi.app (or api@fyi.app for production) and ask them to revoke or rotate the key for your account.
- Rotate the key whenever a developer or tool no longer needs access, or if you suspect the key has been exposed.
If that option is not available
If you are not sure which access type you need or how to lodge the request, ask your developer or implementer to help arrange it with FYI. They can create the staging account, contact developers@fyi.app, and handle the production agreement with your authorisation. You should never need to share your FYI login password to set this up.
Frequently Asked Questions
Not in the usual self-serve way. FYI gates API access behind approval. You build against a staging account first, then request production credentials. If FYI enables the Custom Applications feature for your account, you can generate and manage keys yourself from there, but FYI has to switch that on first.
Either, but in practice the developer, consultant, or tool that will connect usually handles it with your authorisation. They set up the staging account, email developers@fyi.app, build the integration, and arrange the production agreement. You authorise it and confirm who may connect to your account.
Treat it like a password. Where FYI allows, keep the access read-only, share the key only through a secure method such as a password-manager share link rather than plaintext email or chat, and store it somewhere safe. Only the people building the integration should ever hold it.
If the Custom Applications feature is enabled, delete or regenerate the key there as an admin, which invalidates the old one immediately. Otherwise email developers@fyi.app (or api@fyi.app for production) and ask them to revoke or rotate it. Rotate it as soon as a tool no longer needs access.
Staging (preprod) is for building and testing, and FYI issues those keys quickly once you set up a preprod account. Production keys are issued only after you agree to FYI's terms, sign an agreement, and demonstrate the integration, so they take longer and require sign-off.
Related guides
Steps last checked against FYI on 2026-06-09.
Based on official FYI documentation: FYI developer documentation (dev portal), FYI support: Apps and Integrations, FYI staging (preprod) account sign-in. FYI is a trademark of its respective owner; this guide is independent and for instruction only.
Want this handled for you?
Clever Ops connects and automates the systems mid-market businesses already run. Book a free assessment and we will map your stack.