Skip to main content
Jobs API (Application Programming Interface)

Streamline your job management processes using our API

Shoshana Fleischmann avatar
Written by Shoshana Fleischmann
Updated over 2 months ago

Our Jobs API provides a seamless and efficient way to manage and organize your jobs within Connecteam. The API empowers you with the tools to streamline your job management process so that they're ready to use for scheduling in our Job Scheduler and for time tracking in our Time Clock. In this article, we’ll go over what the Jobs API offers and how to set up an API key in just a few easy steps.

What is an API?

An API, or Application Programming Interface, is a set of rules that allows different software applications to communicate with each other. It defines the methods and data structures that developers can use to build and integrate various software components, services, or systems.

Requirements for setting up an API: In-house/3rd party IT development capabilities

Please note: APIs are only available for Enterprise clients. If you are not on the Enterprise plan, this tab will not be available.

Before You Begin

Familiarize yourself with Jobs and the types of fields that can be added to a job's details.

Check out our article about using Jobs in the Job Scheduler to get started!

What We Offer

Retrieve jobs from Connecteam: View jobs that have been created in Connecteam.

Create jobs: Create jobs on your platform that will automatically sync with Connecteam. Whether it's new clients, bookings, or worksites - this API allows you to manage them all on your business's internal platforms.

Update jobs: In the case that job information needs to be updated, you can now do this by simply updating the details on your end. For example, if a client's address changes, you can easily update the location field.

Delete jobs: Remove all irrelevant jobs from the jobs list to enhance organization, minimize confusion, and prevent mistakes.

View our API Documentation here.

How to Set Up an API Key

1. Go to your General Settings and navigate to the 'API keys' tab. This setting is accessible to owners only.

2. Click on ‘Add API key’

3. Add a key name and expiry date and time (optional)

4. Receive a code — that’s your API key.

This API key works with Users, Forms, and Job Scheduler as well.

5. Copy it to your company’s internal systems to implement the connection.

To edit, disable, or delete the API key, click on the three dots and select the desired action.

*API is available for the Enterprise plan only*

Related Articles

Need more guidance? 🙋 Our LIVE support team (at the bottom right corner of your screen) replies in under 5 mins to ANY question.

Did this answer your question?