API ReferenceCustom AppsChangelogCommunity
Log inSign up

Introduction

Copilot is the best way to start, run, and grow a modern, tech-enabled, service business.

Background

Whether you work at a marketing agency, accounting firm, recruiting agency, or tech-enabled services startup, you might need help to provide clients with a streamlined experience.

Specifically, you are likely using email and a suite of SaaS tools for communication, payments, file-sharing, eSignatures, etc. Unfortunately, when you do that, your clients now have multiple separate accounts to manage, get emails from several different services, and have a fragmented user experience.

Copilot solves this problem:

  1. You can set up a portal with powerful out-of-the-box modules for messaging, payments, file-sharing, eSignatures, intake forms, and more. Your clients get one unified account to work with you.
  2. You can customize your portal so that it reflects your brand. Copilot is fully white-label, so you can connect a custom domain for your portal, set up a custom email for notifications, design your theme, and more.
  3. You can extend your portal with custom functionality. You can use Partner Apps to embed products like Airtable and Google Data Studio. Or you can use Custom Apps to embed your own web app and dynamically render data based on the active client user.
  4. You can set up automations within your portal to automate onboarding, repetitive tasks, and more. Additionally, you can connect external tools like HubSpot and SalesForce.

This API documentation will focus on points (3) and (4).

Getting Started

Before jumping into the API documentation we recommend that you familiarize yourself with the core product first.

  1. You can start a free trial here.
  2. You can watch a 10 minute product tour here.

Support

To receive support from the Copilot team you can use the Help Center that is accessible in the bottom-left of your portal or you can email [email protected].

To join the Copilot API community you can join our Slack group here and join the #API channel.

API Enhancements

Over time you can expect comprehensive API support for all Copilot resources — messages, files, invoices, forms, etc. We do weekly releases every Wednesday, and you can track updates to our API here.

Rate Limits

The API is limited to 20 requests per second, 2000 requests per day. If you exceed this rate, you will receive a 429 status code. Subsequent requests will succeed after one second.