Resource URL

Returns a specific job object.

GET /jobs/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.
_filters	partial string	You 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.

id	unsigned int	Unique id assigned to the job
title	string
against	string	Resource endpoint for the object the job is against. For example, /companies/12
date_created	unix timestamp
date_modified	unix timestamp
date_started	unix timestamp
date_due	unix timestamp
date_completed	unix_timestamp
standing	string	e.g, pending, active, inactive or complete.
paused	unsigned int
rate_charged	decimal
type	unsigned int or object	Contains the job's type id or if using parenthesis, the job's rate object.
rate	unsigned int or object	Job's rate id or object.
status	unsigned int or object	Job's status id or object.
manager	unsigned int or object	Job's manager (staff) id or object.
modified_by	unsigned int or object	The staff id or object of the last user to modify the job.
company	unsigned int or object	Job's company id or object.
against_id	unsigned int	The id of the object the job is against. E.g, 42
against_type	string	The name of the object the job is against. E.g, companies.
new object_budget	Object	The budget object for job.
new affiliation	Object
new date_started	unix timestamp
new date_last_interacted	unix timestamp
new breadcrumbs	Array

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.