Resource URL

Returns a specific issue object.

GET /issues/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

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	Issue's unique identifier. This can be used to request other endpoints.
title	string
custom_id	string
description	string
type	unsigned int
type(<fields>)	object
against	string	Resource endpoint representing the object the issue is against. For example, /companies/12
against_id	unsigned	e.g, 12
against_type	string	e.g, company or job
contact	unsigned int
contact(<fields>)	object
class	unsigned int
class(<fields>)	object
priority	unsigned int
priority(<fields>)	object
resolution	unsigned
resolution(<fields>)	object	Default: fields: id and title. Optional fields: parent, description, report and standing.
status	unsigned int
status(<fields>)	object
status(<fields>)	object	Default Fields: id and title. Optional fields: color, icon, factor, target and unit.
standing	string	e.g, submitted, open, resolved, closed and inactive
submitted_by	unsigned int	Returns unique identifier of the staff who submitted the issue. This can be used on the staff endpoints.
submitted_by(<fields>)	object	Returns object of the staff who submitted the issue. For more information on fields, please see GET staff object.
date_submitted	unix timestamp
date_opened	unix timestamp
date_resolved	unix timestamp
date_closed	unix timestamp
date_started	unix timestamp
date_due	unix timestamp
closed_by(<fields>)	object	Returns object of the staff who closed the issue. For more information on fields, please see GET staff object.
opened_by(<fields>)	object	Returns object of the staff who opened the issue. For more information on fields, please see GET staff object.
resolved_by(<fields>)	object	Returns object of the staff who resolved the issue. For more information on fields, please see GET staff object.
company(<fields>)	object	Only available if issue is against company. For more information on company fields, please see the GET company endpoint.
object_budget(<fields>)	object	See GET object_budgets/:object_budget_id for details.
closed_by	unsigned int	Returns unique identifier of the staff who closed the issue. This can be used on the staff endpoints.
opened_by	unsigned int	Returns unique identifier of the staff who opened the issue. This can be used on the staff endpoints.
resolved_by	unsigned int	Returns unique identifier of the staff who resolved the issue. This can be used on the staff endpoints.
company	unsigned int	Only available if issue is against company. For more information on company fields, please see the GET company endpoint.
object_budget	unsigned int	See GET object_budgets/:object_budget_id for details.
assignee(<fields>)	object	Returns the assignee staff object. For more information on fields, please see GET staff object.
assignee	unsigned int	Returns the assignee's staff unique identifier. This can be used on the staff endpoints.
new `billable_seconds`	unsigned int	The billable time in seconds.
new date_last_interacted	unix timestamp
new breadcrumbs	Array
new contract(<fields>)	object	If the issue has a contract, this will return the issue's contract object.
new contract	unsigned int	If the issue has a contract, this will return the issue's contract id.
new integration_link	object	If the issue has integration links, this will return the issue's integration link objects e.g. _fields=integration_link(date_modified, against_id) Default fields: id, service, permalink Optional fields: username, date_modified, date_remote_modified, external_key, external_domain, against_id and against_type NOTE: When you use _fields=integration_link, it would return an array of integration links held by property integration_links (Plural form)
new resolution_detail	unsigned int	If the issue has a resolution detail, return the resolution detail as a string

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

GET /issues/12.json?_fields=contact

would return the issue's affiliation id,

GET /issues/12.json?_fields=contact(email)

would return the affiliation object, including any optional fields or objects within the parenthesis. In the above examples case, it would return the staff objects default values and optional email value.

Sample Response

GET /issues/8.json?_fields=submitted_by(email),company(contact(status()))

{
   "response" : {
         "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@lexisnexis.com.au",
               "status" : {
                  "id" : "3",
                  "title" : "Active"
               },
               "id" : "11564",
               "mobile" : "0400 200 100",
               "surname" : "Jenkins"
            },
            "id" : "10317"
         }
      },
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}