- style
GET /issues
Resource URL
Returns an array of issues.
GET /issues
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. |
| _filters | partial string |
Filtering issues
You can filter the returned list using the _filters parameter.
| Name | Example | Description |
|---|---|---|
| standing(<values>) | assignee(resolved,closed) | Only return issues with the provided standing(s) |
| type(<values>) | type(1,4) | |
| affiliation(<values>) | affiliation(54,65) | Only with affiliations 54 or 65. |
| class(<values>) | class(32) | |
| priority(<values>) | priority(1,2,3,4,5) | |
| resolution(<values>) | resolution(1,65,23) | |
| status(<values>) | status(32,64) | |
| NEW contract | contract(1,4) | |
| NEW referrer_type | referrer_type(prospect) | |
| NEW referrer_id | referrer_id(1, 4) | |
| min_id(<id>) | min_id(12) | Only return issues with ids greater or equal to |
| max_id(<id>) | max_id(120) | Only return issues with ids less or equal to |
| against(type1(...),typeN(...)) | _filters=against(company(1,4), job(2,4)) | Only return tasks with the matching against values. The example will only return issues against company 1 and 4 or issues against job 1 and 4. |
| order_by_asc(<value>), order_by_desc(<value>) | order_by_desc(id) | Accepts: id, date_opened, date_submitted, date_started, date_due, date_closed NEW date_resolved, title, status, standing and date_last_interacted |
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>) | _filters=id_greater_than(5) | Available fields: id billable_seconds |
date_<field>_after,(<unix time>) date_<field>_after_or_equal(<unix time>) date_<field>_before(<unix time>) date_<field>_before_or_equal(<unix time>) | _filters=date_closed_before(1431637176) | Filter issues by date ranges. Fields: closed, opened, submitted, due and started. |
| date_<field>(<unix time>) | _filters=date_closed(1431637176) | Find issues that date falls on the same date as the supplied unix timestamp. Fields: closed, opened, submitted, due and started. |
Using the _not suffix (e.g, id_not) on standard in filters will return results not in.
Handling the response
For handling the response fields, please see GET issue.
Sample Response
GET /issues.json?_limit=2&_fields=submitted_by(email),company(contact(status()))
{
"response" : [
{
"submitted_by" : {
"firstname" : "Geoff",
"email" : "geoff.mcqueen@affinitylive.com",
"id" : "1000",
"surname" : "McQueen"
},
"id" : "1",
"title" : "New System Bugs + Suggestions",
"company" : {
"name" : "Internetrix",
"contact" : {
"firstname" : "Bob",
"email" : "Bob.abbas@internetrix.net",
"status" : {
"id" : "4",
"title" : "Inactive"
},
"id" : "12483",
"mobile" : "0400 100 400",
"surname" : "Abbas"
},
"id" : "7"
}
},
{
"submitted_by" : {
"firstname" : "Geoff",
"email" : "geoff.mcqueen@affinitylive.com",
"id" : "1000",
"surname" : "McQueen"
},
"id" : "8",
"title" : "diary scaping not occuring",
"company" : {
"name" : "Lexis Nexis / Locus Software",
"contact" : {
"firstname" : "John",
"email" : "John.Smith@laughnexis.com.au",
"status" : {
"id" : "3",
"title" : "Active"
},
"id" : "11564",
"mobile" : "0400 200 300",
"surname" : "Jenkins"
},
"id" : "10317"
}
}
],
"meta" : {
"status" : "ok",
"message" : "Everything executed as expected."
}
}