The following macros are not currently supported in the header:
  • style

GET /jobs/:id

Resource URL

Returns a specific job object.

GET /jobs/:id

Parameters

Table of allowed parameters.

_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.
_filterspartial stringYou can filter jobs using this parameter.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

idunsigned intUnique id assigned to the job
titlestring 
againststringResource endpoint for the object the job is against. For example, /companies/12
date_createdunix timestamp 
date_modifiedunix timestamp 
date_startedunix timestamp 
date_dueunix timestamp 
date_completedunix_timestamp 
standingstringe.g, pending, active, inactive or complete.
pausedunsigned int 
rate_chargeddecimal 
typeunsigned int or objectContains the job's type id or if using parenthesis, the job's rate object.
rateunsigned int or objectJob's rate id or object.
statusunsigned int or objectJob's status id or object.
managerunsigned int or objectJob's manager (staff) id or object.
modified_byunsigned int or objectThe staff id or object of the last user to modify the job.
companyunsigned int or objectJob's company id or object.
against_idunsigned intThe id of the object the job is against. E.g, 42
against_typestringThe name of the object the job is against. E.g, companies.
NEW object_budgetObjectThe budget object for job.
NEW affiliationObject 
NEW date_startedunix timestamp 

NEW date_last_interacted

unix timestamp 
NEW breadcrumbsArray 

 

Fields that can be object indicate the field can be requested as a resource. For example.

GET /jobs/1.json?_fields=manager

would return the manager's staff id. Where as,

GET /jobs/1.json?_fields=manager()

would return the manager's staff object, including any optional fields or objects within the parenthesis.