For businesses striving to optimize their operations, our Job Scheduler API opens a realm of possibilities. Beyond minimizing data redundancies and inaccuracies, you can now work with Connecteam’s Job Scheduler in a way that’s tailored to your operations. With the use of a third-party system, effortlessly streamline your processes and sync shifts in real-time with speed and precision. In this article, we’ll go over what the Job Scheduler API offers and how to set up an API key in just a few easy steps.

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.

Get yourself familiar with the Job Scheduler. Understand the difference between published and draft shifts, assigned and unassigned shifts, open shifts and repeating shifts. Learn about the field options provided when creating a shift (date and time, timezone, shift title, jobs, users, location, notes).

Check out our Starting Guide to the Job Scheduler to learn about all these and more!

Please note: data layers, shift tasks, repeating shifts, and group shifts are currently unsupported.

Retrieve all shifts from Connecteam: Get an idea of what shifts have already been created in Connecteam. For example: have published shifts appear on your system for clients to book caregivers, handymen, or cleaners.

Update shifts in bulk: Save time by updating fields in several shifts all at once. If a client’s location has changed and shifts have already been created, you can go ahead and update the location fields for that client only.

Create new shifts: Create new shifts in your system and publish them on Connecteam. For example, as soon as you have all the information you need in your system for shifts that need to be allocated, publish them as open shifts for your staff to start claiming. When an appointment is scheduled or a booking is reserved on your platform, automatically create a shift in Connecteam.

Delete shifts in bulk: Did bookings get deleted or your schedule needs a do-over? You can choose which shifts need to be deleted, and remove them all at once.

Retrieve a specific shift: If you need to keep track of changes for a specific shift, get a specific shift’s information right to your platform.

Delete a specific shift: If there’s a specific shift that needs to be removed, remove only this shift without impacting others. If a reservation is deleted, a client cancels, or a staff member is double-booked, easily remove the shift to prevent confusion.

Retrieve user unavailabilities: Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts

Retrieve shift layers data: Obtain a list of shift layers and their corresponding values for a specified scheduler. This information can be used to create new shifts utilizing the defined shift layers.

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 the Forms API and Users API 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.

Update User Information Using API

Forms API

Jobs API

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