AccuLynx

App · 25 actions

Find jobs, contacts, appointments, estimates and company settings, and create jobs.

Actions

ActionWhat it does
Create JobCreate Job.
Get active lead sourcesGet active lead sources.
Get Appointment DetailsGet Appointment Details.
Get Calendar AppointmentsGet Calendar Appointments.
Get CalendarsGet Calendars.
Get Company SettingsGet Company Settings.
Get Contact by IDGet Contact by ID.
Get contact note by idGet contact note by id.
Get contact notesGet contact notes.
Get Contact TypesGet Contact Types.
Get ContactsGet Contacts.
Get EstimatesGet Estimates.
Get Job by IDGet Job by ID.
Get job categoriesGet job categories.
Get Job EstimatesGet Job Estimates.
Get Job Milestone HistoryGet Job Milestone History.
Get JobsGet Jobs.
Get Jobs for a ContactGet Jobs for a Contact.
Get MilestonesGet Milestones.
Get Statuses for a MilestoneGet Statuses for a Milestone.
Get trade typesGet trade types.
Get UserGet User.
Get UsersGet Users.
Get work typesGet work types.
PingPing.

Create Job

Create Job.

Inputs

ContactcontactobjectRequired
Additional structured contact. Use the documented fields.
Lead sourcelead_sourceobject
Additional structured lead source. Use the documented fields.
Location addresslocation_addressobject
Additional structured location address. Use the documented fields.
Priorityprioritytext
The priority level for this job.One of: Urgent, High, Normal.
Job categoryjob_categoryobject
Additional structured job category. Use the documented fields.
Work typework_typeobject
Additional structured work type. Use the documented fields.
Trade typestrade_typeslist
The trade types to assign to this job. Each entry must reference a valid trade type configured in company settings.
Notesnotestext
A note or remark for this new job.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get active lead sources

Get active lead sources. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Appointment Details

Get Appointment Details. Returns the full service response for the connected account.

Inputs

Calendarcalendar_idtextRequired
The calendar's unique identifier
Appointment IDappointment_idtextRequired
The appointment's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "allDay": true,
    "end": "example",
    "eventType": "Personal",
    "id": "example",
    "jobId": "example",
    "jobName": "example",
    "location": "example",
    "notes": "example",
    "start": "example",
    "title": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Calendar Appointments

Get Calendar Appointments. Gets one page; to see more, run it again with the next page it gives.

Inputs

Calendarcalendar_idtextRequired
The calendar's unique identifier
Event typeevent_typetext
Enter one or more event types, separated by commas. Only events with the specified types will be included in the response. If no value is specified, the default value will be "All". Possible values: All, Personal, InitialAppointment, MaterialDelivery, CrewLabor
Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.
Start datestart_datedateRequired
Start date for the query, in YYYY-MM-DD format.
End dateend_datedateRequired
End date for the query, in YYYY-MM-DD format.
Jobjob_idtext
The job's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Calendars

Get Calendars. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Company Settings

Get Company Settings. Returns the full service response for the connected account.

Inputs

None.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "companyId": "example",
    "hasInsurance": true,
    "name": "example",
    "timeZoneInfo": {
      "adjustedUtcOffset": "example",
      "baseUtcOffset": "example",
      "daylightName": "example",
      "name": "example",
      "supportsDaylightSavingTime": true
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get Contact by ID

Get Contact by ID. Returns the full service response for the connected account.

Inputs

Contactcontact_idtextRequired
The contact's unique identifier
Includesincludestext
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.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "billingAddress": {
      "city": "example",
      "country": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "state": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "street1": "example",
      "street2": "example",
      "zipCode": "example"
    },
    "companyName": "example",
    "createdDate": "example",
    "crossReference": "example",
    "emailAddresses": [],
    "firstName": "example",
    "id": "example",
    "lastName": "example",
    "mailingAddress": {
      "city": "example",
      "country": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "state": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "street1": "example",
      "street2": "example",
      "zipCode": "example"
    },
    "modifiedDate": "example",
    "phoneNumbers": [],
    "salutation": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get contact note by id

Get contact note by id. Returns the full service response for the connected account.

Inputs

Contactcontact_idtextRequired
The contact's unique identifier
Note IDnote_idtextRequired
The note's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "createdBy": {
      "_link": "example",
      "id": "example"
    },
    "createdDate": "example",
    "id": "example",
    "note": "example",
    "updatedBy": {
      "_link": "example",
      "id": "example"
    },
    "updatedDate": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get contact notes

Get contact notes. Gets one page; to see more, run it again with the next page it gives.

Inputs

Contactcontact_idtextRequired
The contact's unique identifier
Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Contact Types

Get Contact Types. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The index of the page to return

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Contacts

Get Contacts. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The index of the page to return
Includesincludestext
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.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Estimates

Get Estimates. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The value of pageStartIndex will specify the index of the record that the list begins with.
Includesincludestext
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.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Job by ID

Get Job by ID. Returns the full service response for the connected account.

Inputs

Includesincludestext
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.
Jobjob_idtextRequired
The job's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "contacts": [],
    "createdDate": "example",
    "currentMilestone": "Lead",
    "geoLocation": {
      "latitude": 1,
      "longitude": 1
    },
    "id": "example",
    "initialAppointment": {
      "_link": "example"
    },
    "jobCategory": {
      "id": 1,
      "name": "example"
    },
    "jobName": "example",
    "jobNumber": "example",
    "leadDeadReason": "example",
    "leadSource": {
      "_link": "example",
      "children": [],
      "id": "example",
      "name": "example"
    },
    "locationAddress": {
      "city": "example",
      "country": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "state": {
        "_link": "example",
        "abbreviation": "example",
        "id": 1,
        "name": "example"
      },
      "street1": "example",
      "street2": "example",
      "zipCode": "example"
    },
    "milestoneDate": "example",
    "modifiedDate": "example",
    "priority": "Normal",
    "tradeTypes": [],
    "workType": {
      "_link": "example",
      "id": 1,
      "name": "example",
      "systemDefault": true
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get job categories

Get job categories. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Job Estimates

Get Job Estimates. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The value of pageStartIndex will specify the index of the record that the list begins with.
Jobjob_idtextRequired
The job's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Job Milestone History

Get Job Milestone History. Returns the full service response for the connected account.

Inputs

Jobjob_idtextRequired
The job's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}

Get Jobs

Get Jobs. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
The maximum number of items to return per page. Defaults to 10 when not specified. Maximum is 25.At most 25.
Page start indexpage_start_indexnumber
The value of pageStartIndex will specify the index of the record that the list begins with.
Includesincludestext
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.
Start datestart_datedate
The start of the date range to filter by, in `YYYY-MM-DD` format (inclusive). When provided with `endDate`, must be earlier than `endDate`.
End dateend_datedate
The end of the date range to filter by, in `YYYY-MM-DD` format (inclusive). When provided, must be greater than `startDate`.
Date filter typedate_filter_typetext
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.One of: CreatedDate, MilestoneDate, ModifiedDate.
Milestonesmilestonestext
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.
Sort bysort_bytext
The field to sort jobs by. Defaults to `CreatedDate`.One of: CreatedDate, MilestoneDate, ModifiedDate.
Sort ordersort_ordertext
The sort direction for the results. Defaults to `Ascending`.One of: Ascending, Descending.
Assignmentassignmenttext
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.One of: assigned, unassigned.

Outputs

dataobject
A paginated collection of job records.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Jobs for a Contact

Get Jobs for a Contact. Gets one page; to see more, run it again with the next page it gives.

Inputs

Contactcontact_idtextRequired
The contact's unique identifier
Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The value of pageStartIndex will specify the index of the record that the list begins with.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get Milestones

Get Milestones. Returns the full service response for the connected account.

Inputs

Includesincludestext
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.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}

Get Statuses for a Milestone

Get Statuses for a Milestone. Returns the full service response for the connected account.

Inputs

MilestonemilestonetextRequired
Include only status currently in one of the listed milestone. Only one value is allowed. Possible values: lead, prospect, approved, completed, invoiced, closed, cancelled

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "id": "example",
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get trade types

Get trade types. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get User

Get User. Returns the full service response for the connected account.

Inputs

App userapp_user_idtextRequired
The user's unique identifier

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "_link": "example",
    "displayName": "example",
    "email": "example",
    "firstName": "example",
    "id": "example",
    "initials": "example",
    "lastName": "example",
    "mobilePhone": "example",
    "phone": "example",
    "role": {
      "id": 1,
      "name": "Company Administrator"
    },
    "status": "Active"
  },
  "has_more": false,
  "next_cursor": null
}

Get Users

Get Users. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Page start indexpage_start_indexnumber
The value of pageStartIndex will specify the index of the record that the list begins with.
Statusstatustext
Return users of the listed status. Possible values are Active, Inactive, Archived, and Deleted. Multiple values are given comma seperated. To return all users - Active,Inactive,Archive,Deleted. When no status parameter is given, the Active users are returned.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get work types

Get work types. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizepage_sizenumber
How many items to be returned at a time.
Record start indexrecord_start_indexnumber
The zero-based index of the first record to return.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "items": [],
    "pageSize": 1,
    "pageStartIndex": 1
  },
  "has_more": false,
  "next_cursor": null
}

Ping

Ping. Returns the full service response for the connected account.

Inputs

None.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "date": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page