jobs

Get Jobs

Changed on Nov 3, 2026

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.

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&dateFilterType=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 contact) that were modified in March sorted most recent first (descending ModifiedDate)

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

/jobs?assignment=unassigned&milestones=Lead&pageSize=25&includes=contact&dateFilterType=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30

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

/jobs?assignment=unassigned&milestones=Cancelled&pageSize=25&includes=contact&dateFilterType=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30

get/jobs

Request

Base URL
https://api.acculynx.com/api/v2
URL
https://api.acculynx.com/api/v2/jobs
Auth
HTTP bearer

Query parameters

pageSizeinteger

The maximum number of items to return per page. Defaults to 10 when not specified. Maximum is 25.

pageStartIndexinteger

The value of pageStartIndex will specify the index of the record that the list begins with.

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

startDatestring date

The start of the date range to filter by, in YYYY-MM-DD format (inclusive). When provided with endDate, must be earlier than endDate.

endDatestring date

The end of the date range to filter by, in YYYY-MM-DD format (inclusive). When provided, must be greater than startDate.

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

The date field that startDate and endDate apply to. CreatedDate: when the job was created; MilestoneDate: when the job last changed milestone; ModifiedDate: when the job was last updated. Ignored when neither date parameter is provided.

milestonesstring

Filter to only jobs currently in one of the listed milestones. Enter one or more values separated by commas. When omitted, all milestones are returned.

Accepted values: lead, prospect, approved, completed, invoiced, closed, cancelled.

Note: dead is accepted as a backwards-compatible alias for cancelled. When filtering by cancelled or dead, set assignment=unassigned to include jobs in that milestone.

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

The field to sort jobs by. Defaults to CreatedDate.

sortOrder'Ascending' | 'Descending'

The sort direction for the results. Defaults to Ascending.

assignment'assigned' | 'unassigned'

Filter results by assignment status. Use unassigned to return only jobs with no assigned representative, assigned for jobs with one, or omit to return all jobs regardless of assignment.

Response

A paginated collection of jobs matching the specified filters.

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
      "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0",
      "contacts": [
        {
          "id": "989ea7b8-f579-4db3-8417-bae1b3a8cd21",
          "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0/contact/989ea7b8-f579-4db3-8417-bae1b3a8cd21",
          "relationToPrimary": "Cousin",
          "contact": {
            "id": "61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
            "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
            "firstName": "John",
            "lastName": "Smith",
            "salutation": "Mr.",
            "companyName": "Acme Roofing Inc.",
            "phoneNumbers": [
              {
                "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
                "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b"
              }
            ],
            "emailAddresses": [
              {
                "id": "40ac2713-13eb-4c69-8780-eee57fc71cba",
                "_link": "https://api.acculynx.com/api/v2/contacts/d0b29a1b-6023-4a27-b028-25e85796c40b/email-addresses/40ac2713-13eb-4c69-8780-eee57fc71cba"
              }
            ],
            "mailingAddress": {
              "street1": "123 Main St.",
              "street2": "Apt 2",
              "city": "Peoria",
              "state": {
                "id": 43,
                "name": "Texas",
                "abbreviation": "TX",
                "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
              },
              "zipCode": "61603",
              "country": {
                "id": 1,
                "name": "United States",
                "abbreviation": "US",
                "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
              }
            },
            "billingAddress": {
              "street1": "123 Main St.",
              "street2": "Apt 2",
              "city": "Peoria",
              "state": {
                "id": 43,
                "name": "Texas",
                "abbreviation": "TX",
                "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
              },
              "zipCode": "61603",
              "country": {
                "id": 1,
                "name": "United States",
                "abbreviation": "US",
                "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
              }
            },
            "createdDate": "2024-03-15T10:30:00Z",
            "modifiedDate": "2025-06-20T14:00:00Z"
          }
        }
      ],
      "locationAddress": {
        "street1": "123 Main St.",
        "street2": "Apt 2",
        "city": "Peoria",
        "state": {
          "id": 43,
          "name": "Texas",
          "abbreviation": "TX",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
        },
        "zipCode": "61603",
        "country": {
          "id": 1,
          "name": "United States",
          "abbreviation": "US",
          "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
        }
      },
      "geoLocation": {
        "latitude": 40.689,
        "longitude": -74.044
      },
      "tradeTypes": [
        {
          "tradeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "Windows"
        }
      ],
      "jobCategory": {
        "id": 1,
        "name": "Residential"
      },
      "workType": {
        "id": 2,
        "_link": "https://api.acculynx.com/api/v2/company-settings/job-file-settings/work-types/2",
        "name": "Insurance"
      },
      "leadSource": {
        "id": "f29b31a2-607e-4550-ab0b-8ff48f532253",
        "name": "Lead source",
        "_link": "https://api.acculynx.com/api/v2/company-settings/leads/lead-sources/f29b31a2-607e-4550-ab0b-8ff48f532253"
      },
      "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"
    }
  ]
}

Changes

Nov 3, 2026443924b00f43 Revision changes
- breaking
  for the query request parameter pageSize, default value was changed from 25 to 10
- breaking
  for the query request parameter milestones, default value lead,prospect,approved,completed,invoiced,closed,cancelled was removed
- breaking
  added to the /////// response property oneOf list for the response status
- breaking
  the ////////// response's property format changed from uri to no format for status
- breaking
  the //// response's property type changed from object to no type for status
- breaking
  the ////// response's property format changed from uri to no format for status
- breaking
  the //// response's property type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  for the query request parameter pageSize, the max was set to 25.00
- warning
  deleted the query request parameter recordStartIndex
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the new optional query request parameter pageStartIndex
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property to the response with the status
- info
  added subschema #2 to the //// response property allOf list for the response status
- info
  added subschema #2 to the //// response property allOf list for the response status
- info
  removed subschema #2 from the /////// response property allOf list for the response status

Operation history