Jobs

Retrieve jobs list

List a collection of jobs

get/jobs

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/jobs
  • Auth
    API key in header x-api-key

Query parameters

pagestring

Page number. Starts from 1, defaults to 1.

limitstring

Defaults to 20 items per page, maximum 100 items allowed.

searchstring

Search string.

sort_bystring

Allowed values: created_at, updated_at.

sort_dirstring

Allowed values: asc, desc

created_fromstring

Job's created_at UNIX timestamp.

created_tostring

Job's created_at UNIX timestamp.

status_idstring

Comma separated custom status ids

with_custom_fieldsstring

Optional. Possible values are true or false. If true, the response will contain custom fileds data in customfields_with_related_data key

qb_classstring

Parameter for filtering by quickbook class name.

filterstring

Array of attribute, operator, and value parts.

asnstring

Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.

sortstring

Array of attribute and order values.

relstring

array consisting of indices with the desired relation to include

Response

Successful response

errorboolean

false when the request succeeds.

total_countinteger

Total number of records that match the request, across all pages.

responseobject[]

Example response

{
  "total_count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.