Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Get Jobs

Use this endpoint to get a listing of Jobs.

When startDate and endDate are specified, jobs returned will be filtered to the given date range (inclusive).

The date field to filter on is given with dateFilterType which defaults to CreatedDate.

Optionally use milestones to limit the jobs to those in the listed milestones.

Optionally use sortBy to sort jobs by either CreatedDate, MilestoneDate, or ModifiedDate. CreatedDate is the default.

Optionally use sortOrder to indicate newest to oldest (Descending) ordering or oldest to newest (Ascending) ordering. Ascending is the default.

The pageStartIndex parameter to start looking for records should not exceed 100000

To Get Jobs:

Supported includes: contact, initialAppointment.

Example: return the jobs (including initial appointment) that are prospects and were modified in April sorted most recent first (descending ModifiedDate).

/jobs?pageSize=25&includes=initialAppointment&filterByDate=ModifiedDate&startDate=2021-04-01&endDate=2021-04-30&sortBy=ModifiedDate&sortOrder=Descending

To Get Unassigned Jobs:

Supported includes: contact.

Example: return the unassigned jobs (including contacts) that were modified in March sorted most recent first (descending ModifiedDate)

/jobs?assignment=unassigned&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30&sortBy=ModifiedDate&sortOrder=Descending

jobs?assignment=unassigned&milestones=Lead&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30

Example: return the unassigned jobs (including contacts) that were marked as Dead

/jobs?assignment=unassigned&milestones=Dead&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30

get/jobs

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element to return

includesstring

Optional fields to include in full with the response.

startDatestring date

Start date for the query, in YYYY-MM-DD format.

endDatestring date

End date for the query, in YYYY-MM-DD format.

dateFilterType'CreatedDate' | 'MilestoneDate' | 'ModifiedDate'

The date field to which startDate/endDate apply. Ignored when neither startDate nor endDate is given.

milestonesstring

Include only jobs currently in one of the listed milestones. Enter one or more values, separated by commas. The default is no milestone filtering. Possible values: lead, prospect, approved, completed, invoiced, closed, cancelled, dead.

Note: When filtering for dead leads ensure that the assignment is set to unassigned, otherwise no results will be returned.

sortBy'CreatedDate' | 'MilestoneDate' | 'ModifiedDate'

sort the returned jobs by this date field.

sortOrder'Ascending' | 'Descending'

return jobs in Ascending (default) or Descending order

assignment'assigned' | 'unassigned'

Optional field to filter only unassigned jobs in the response. Possible values: unassigned, assigned

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
      "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0",
      "geoLocation": {
        "latitude": 40.689,
        "longitude": -74.044
      },
      "initialAppointment": {
        "_link": "https://api.acculynx.com/api/v2/jobs/3bd1f24d-44f9-4633-83a1-5ff4f3921a01/initial-appointment"
      },
      "leadDeadReason": "Declined",
      "milestoneDate": "2021-01-20T21:18:25Z",
      "createdDate": "2021-01-20T21:18:25Z",
      "modifiedDate": "2021-01-20T21:18:25Z",
      "currentMilestone": "Prospect",
      "jobNumber": "JK-2964",
      "jobName": "JK-2964: John Smith",
      "priority": "Urgent"
    }
  ]
}