Foyer JavaScript API: The Easiest Way To Automate Your Client Portal

With the Foyer JavaScript Client Portal API, integrating with your client portal is easier than ever.

This API, included with the Ultimate Plan, gives you everything you need to manage users, securely share documents, and communicate with clients via JavaScript.

Here’s what you can do with it:

• Manage Users and Roles: Quickly add new clients, staff, and admins, assigning roles and permissions so everyone has access to the right tools and information.
• Create Spaces for File Sharing and Messaging: Set up secure spaces where clients and team members can share files, hold conversations, and keep everything organized by project or client.
• Securely Upload and Download Files: Upload, download, and manage files with confidence—keeping sensitive documents safe and accessible to the right people.
• Send Secure Messages: Keep client communications organized within each space, so you’re always up-to-date on project discussions and updates.
• Customize Your Client Portal with Apps: Make each client’s experience unique by customizing your Apps for each user.

How to Get Started?

Getting started is easy. Just install our JavaScript package npm install @usefoyer/client, plug in your API key, and explore our documentation for easy examples and tips to get up and running.

If you're new to JavaScript or if you're setting up a brand new project, we have a full example repository that you can start from. You're free to use any code from that repository in your own projects.

If you run into any issues or have ideas for improvements, you're welcome to open a PR or raise an issue over on our official GitHub repository. If you need any help getting started, feel free to email us directly and we can help you get started.