Overview
The Jobs API in Connecteam enables you to manage job objects within the platform, whether you're using them as part of the Scheduler or Time Clock features. This API provides full CRUD operations for jobs and sub-jobs, including support for custom fields.
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /jobs/v1/jobs | Get a list of jobs with optional filters |
| GET | /jobs/v1/jobs/{jobId} | Get a single job or sub-job by ID |
| POST | /jobs/v1/jobs | Create one or multiple jobs (max 500 per request) |
| PUT | /jobs/v1/jobs/{jobId} | Update a single job or sub-job |
| DELETE | /jobs/v1/jobs/{jobId} | Delete a job or sub-job |
Key Concepts
Jobs vs Sub-Jobs
- Jobs (Parent Jobs): Top-level job entities that can be assigned to schedulers or time clocks
- Sub-Jobs: Nested jobs under a parent job. Sub-jobs can inherit data from their parent (
useParentData: true) or have their own settings
ImportantOnce a job is created without sub-jobs, you cannot add sub-jobs to it later. Plan your job structure before creation.
Instance IDs
Jobs are associated with instances (Scheduler ID or Time Clock ID). When creating a job, you must specify which instance(s) it belongs to.
Custom Fields
Jobs support custom fields for storing additional data. Custom field values can be set during creation or update operations.
Limitations
- Batch limit: Maximum 500 jobs per create request
- Title length: Maximum 128 characters
- Sub-job deletion: Cannot delete the last remaining sub-job of a parent
- Parent job deletion: Cannot delete a job that has sub-jobs
- Update with sub-jobs: Cannot update a parent job that has nested sub-jobs (update sub-jobs individually)
OAuth Scopes
| Scope | Operations |
|---|---|
| JOBS_READ | GET endpoints |
| JOBS_WRITE | POST, PUT endpoints |
| JOBS_DELETE | DELETE endpoint |
For detailed information and examples, refer to the following pages.
Updated 11 days ago
What’s Next
