Overview

The Jobs API in Connecteam enables you to manage various job objects within the platform, whether you're using them as part of a scheduler or time clock features. This API allows for the effective creation, retrieval, updating, and deletion of jobs, ensuring your operational needs are met flexibly and efficiently.

Upon reviewing this section, you will have all the necessary information to manage your account's jobs via the API, aiding in the efficient tracking and updating of job-related data.

🚧

Important Note

Creating sub-jobs is possible when creating jobs with nested sub-jobs. Updating and archiving sub-jobs is not supported at the moment. Future updates will introduce sub-jobs endpoints to align with the full capabilities available in the UI.

Currently, there are five main endpoints related to job management:

Get Jobs: Retrieve a list of job objects relevant to a specific instance ID, such as a scheduler ID or time clock ID. GET Endpoint

Get a Single Job: Fetch information for a specific job using its unique ID. This endpoint provides detailed insights into individual job settings and statuses.

Create Jobs: Enable the creation of single or multiple jobs under a specified scheduler, including the option to create jobs with nested sub-jobs.

Update Job: Update details of a single job using its unique identifier. Note that updates to sub-jobs or jobs with nested sub-jobs are currently unsupported.

Delete Job: Remove a specific job by its unique identifier. This action does not support the deletion of sub-jobs or jobs with nested sub-jobs.

This document aims to guide you through utilizing the Connecteam Jobs API to efficiently handle job objects. Should you require further assistance, reach out to our amazing support team for more tailored help.