Resource URL
Returns an array of jobs displaying the latest modified first.
| Code Block |
|---|
|
GET /jobs
ANY /jobs?_method=get |
Parameters
Table of allowed parameters.
| _page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
|---|
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
|---|
| _offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page. |
|---|
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
|---|
| _filers | 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_type | string | e.g, hours, budget or fixed. |
|---|
| 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. |
|---|
| budget | unsigned int or object | Job's budget 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. |
|---|
Fields that can be object indicate the field can be requested as a resource. For example.
| Code Block |
|---|
|
GET /jobs.json?_fields=manager |
would return the manager's staff id. Where as,
| Code Block |
|---|
|
GET /jobs.json?_fields=manager() |
would return the manager's staff object, including any optional fields or objects within the parenthesis.