ACacculynx
jobs

Search Jobs

Changed on

Use this endpoint to get a listing of jobs matching the given search criteria. Jobs are returned if they include a given search term and/or they are near a given set of map coordinates. At least one of searchTerm or geoLocation must be included. If both are included, jobs returned must match both criteria.

The size of the return is controlled with the pageSize query parameter which defaults to 10 and must be > 0 and <= 25. Set pageStartIndex >= 0 to access jobs past the first page when more than pageSize jobs meet the search criteria. The pageStartIndex parameter to start looking for records should not exceed 100000.

Unassigned leads or jobs will not be returned.

Supported includes: contact, initialAppointment.

Example: return up to 25 jobs (including initial appointment) that contain "Maple Lane" and are within 1 kilometer of the map location (40.689247,-74.044502).

/jobs/search?pageSize=25&includes=initialAppointment

{
  "searchTerm": "Maple Lane",
  "geoLocation": {
    "latitude": 40.689247,
    "longitude": -74.044502,
    "mapRadius": 1
  }
}
post/jobs/search

Request

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

Query parameters

pageSizeinteger

How many items to be returned at a time.

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.

Request body

searchTermstring

select the jobs that include this term.

Example request

{
  "searchTerm": "Maple Lane",
  "geoLocation": {
    "latitude": 40.689,
    "longitude": -74.044
  }
}

Response

OK

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