Get issues

Get issues with paging(X-Pagination response header for next and previous links)
For additional sorting you can pass a body with these information
Sort : (+)Ascending (-)Descending followed by one of these options (Number, Priority, Status, Type, Title, CreationDate, DueDate, Zone, Phase, AssignedTo, ArchivedOn and LastChanged). Default value is -Number.
AssignedToUserId, PriorityId, StatusId


To work with QuickFilters retrieved from "IssueFilterTemplate" endpoint (/v3/hubs/{hubId}/projects/{projectId}/issuefiltertemplate), use "filters" object.

Possible values are:

filters.term
filters.description
filters.assignedToUserIds
filters.authorUserIds
filters.lastModificationAuthorUserIds
filters.issueGroups
filters.priorityIds
filters.projectPhaseIds
filters.confidentialityIds
filters.projectZoneIds
filters.statusIds
filters.disciplineIds
filters.typeIds
filters.creationDateStart
filters.creationDateEnd
filters.lastModificationDateStart
filters.lastModificationDateEnd
filters.dueDateStart
filters.dueDateEnd
filters.visibility
filters.customAttributes
filters.isUnlinked


e.g. GET /Web.WebAPI/v3/hubs/[HUB_ID]/projects/[PROJECT_ID]/issues

?returnCount=100
?filters.dueDateStart=2020-10-09
?filters.dueDateEnd=2021-11-09
?filters.customAttributes=3=1
?filters.customAttributes=4=custom2value



CustomAttributes, are in a different object array and you have to work with Ids

Here's a response example:

"IssueFilterTemplateProjectAttributeValues": [
{
    "ProjectAttribute": {
        "Id": 3,
        "Type": "Predefined",
        "Name": "Custom1"
    },
    "IssueFilterTemplateProjectAttributePredefinedValues": [
    {
        "ProjectAttributeValue": {
            "Id": 1,
            "Color": "#9F9F9F",
            "Name": "Valeur1"
        }
    }
    ],
    "IssueFilterTemplateProjectAttributeFreeFormValue": null
},
{
    "ProjectAttribute": {
        "Id": 4,
        "Type": "Text",
        "Name": "Custom2"
    },
    "IssueFilterTemplateProjectAttributePredefinedValues": [],
    "IssueFilterTemplateProjectAttributeFreeFormValue": {
        "Value": "custom2value"
    }
}
]


In this example we have 2 Custom attributes.

The first one is Id = 3 and the predefined value is Id = 1

For the second one, Id = 4 and the free form value = "custom2value"

Therefore, it gives:

filters.customAttributes=3=1

filters.customAttributes=4=custom2value

Log in to see full request history
Path Params
string
required

Hub id

int32
required

Project id

Query Params
string

Specify a comma-separated list of optional properties to include with the issues. Possible values: 'Viewpoints', 'ClashGroup'

string
Defaults to -Number

Available sorting: (+)Ascending (-)Descending followed by one of these options (Number, Priority, Status, Type, Title, CreationDate, DueDate, Zone, Phase, AssignedTo, ArchivedOn and LastChanged). Default is "-Number"

int32
Defaults to 1

Record start - Default value to 1 if not specified.

int32
Defaults to 100

Record page size count - Default value to 100 if not supplied. Max value is 100.

int32
Defaults to 0

AssignTo user identifier - optional

int32
Defaults to 0

Priority filter - optional

int32
Defaults to 0

Status filter - optional

string
string
filters.assignedToUserIds
array of int32s
filters.assignedToUserIds
filters.authorUserIds
array of int32s
filters.authorUserIds
filters.lastModificationAuthorUserIds
array of int32s
filters.lastModificationAuthorUserIds
filters.issueGroups
array of strings
filters.issueGroups
filters.priorityIds
array of int32s
filters.priorityIds
filters.projectPhaseIds
array of int32s
filters.projectPhaseIds
filters.confidentialityIds
array of int32s
filters.confidentialityIds
filters.projectZoneIds
array of int32s
filters.projectZoneIds
filters.statusIds
array of int32s
filters.statusIds
filters.disciplineIds
array of int32s
filters.disciplineIds
filters.typeIds
array of int32s
filters.typeIds
date-time
date-time
date-time
date-time
date-time
date-time
int32
filters.customAttributes
array of strings
filters.customAttributes
boolean
Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
application/json-patch+json