Get jobs

The Jobs API provides two methods for retrieving job data:

Get Jobs: Retrieve multiple jobs with optional filters
Get Job: Retrieve a single job or sub-job by its ID

Get Jobs

GET /jobs/v1/jobs

Retrieve a list of jobs with optional filters. Returns paginated results.

Query Parameters

Parameter	Type	Required	Description
instanceIds	array	No	Filter by scheduler or time clock IDs
jobIds	array	No	Filter by job IDs. Returns parent jobs with all their sub-jobs
jobNames	array	No	Filter by job names (case-sensitive)
jobCodes	array	No	Filter by job codes
includeDeleted	boolean	No	Include deleted jobs (default: true)
sort	string	No	Sort field. Supported: `title`
order	string	No	Sort order: `asc` or `desc` (default: asc)
limit	integer	No	Results per page (default: 10, max: 500)
offset	integer	No	Pagination offset

Request Example

curl -X GET \
  'https://api.connecteam.com/jobs/v1/jobs?instanceIds=6833518&includeDeleted=false&limit=100' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response Example

{
  "requestId": "abc123-def456",
  "data": {
    "paging": {
      "offset": 100
    },
    "jobs": [
      {
        "jobId": "9fdebf1f-0c69-4914-89d2-8f86c3e5f47d",
        "title": "Delivery Driver",
        "code": "DD-001",
        "color": "#3968BB",
        "description": "Delivery operations",
        "gps": {
          "address": "123 Main St",
          "longitude": -73.93,
          "latitude": 40.71
        },
        "isDeleted": false,
        "assign": {
          "type": "both",
          "userIds": [7031021],
          "groupIds": []
        },
        "useParentData": false,
        "parentId": null,
        "subJobs": [],
        "instanceIds": [6833518],
        "customFields": []
      }
    ]
  }
}

Get Job

GET /jobs/v1/jobs/{jobId}

Retrieve a single job or sub-job by its unique ID. This endpoint works for both parent jobs and sub-jobs.

Path Parameters

Parameter	Type	Required	Description
jobId	string	Yes	The unique identifier of the job or sub-job

Request Example

curl -X GET \
  'https://api.connecteam.com/jobs/v1/jobs/9fdebf1f-0c69-4914-89d2-8f86c3e5f47d' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response Example

{
  "requestId": "abc123-def456",
  "data": {
    "job": {
      "jobId": "9fdebf1f-0c69-4914-89d2-8f86c3e5f47d",
      "title": "Delivery Driver",
      "code": "DD-001",
      "color": "#3968BB",
      "description": "Delivery operations",
      "gps": {
        "address": "123 Main St",
        "longitude": -73.93,
        "latitude": 40.71
      },
      "isDeleted": false,
      "assign": {
        "type": "both",
        "userIds": [7031021],
        "groupIds": []
      },
      "useParentData": false,
      "parentId": null,
      "subJobs": [],
      "instanceIds": [6833518],
      "customFields": []
    }
  }
}

Error Responses

Status	Error	Description
404	Job not found	The specified jobId does not exist

Get Jobs API reference