Returns an array of objects by running the filter with given id.

GET /filters/:id/run

Modified Date Inaccuracies

Some filters may not be supported by current API version.

Parameters

Table of allowed parameters.

_limit

unsigned int

The maximum number of resources to return. Default is 10 and maximum is 50.

_fields

partial string

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

NOTE: The fields that you can specify depend on the object against the saved filter. Please check the specific object documentation for detailed fields.

Handling the response

Sample Response

GET /filters/4/run.json?_fields=affiliation(status)

{
    "meta": {
        "more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
        "message": "Everything executed as expected.",
        "status": "ok"
    },
    "response": [
        {
            "affiliation": {
                "mobile": "1234",
                "status": "1",
                "id": "1",
                "email": "email@example.com"
            },
            "id": "1",
            "name": "name a"
        },
        {
            "name": "name b",
            "id": "2",
            "affiliation": {
                "id": "2",
                "email": "email@example.com",
                "status": "1",
                "mobile": ""
            }
        }
    ]
}

APIs

Run filter

Parameters

Handling the response

Sample Response