API References

Get Jobs

get
https://api.acculynx.com/api/v2/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.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≤ 25
Defaults to 10

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

integer
Defaults to 0

The zero-based index of the first record to return.

string

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.

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.

date

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

string
enum
Defaults to CreatedDate

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.

Allowed:
string

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.

string
enum
Defaults to CreatedDate

The field to sort jobs by. Defaults to CreatedDate.

Allowed:
string
enum
Defaults to Ascending

The sort direction for the results. Defaults to Ascending.

Allowed:
string
enum

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.

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?