Get all Filter Lists¶

Get information for all filter lists that belong to a specific contract.

Endpoint¶

GET https://api.crowdynews.com/collection/lists

Request Parameters¶

QUERY PARAMETER	VALUE DESCRIPTION
access_token	A valid OAuth access token with the correct permission(s).
contract_id	A resource ID that specifies on which contract to filter. The consumer that wants to retrieve the lists must have access to the specified contract, otherwise this action is forbidden.

Response Format¶

On success, the HTTP status code in the response header is 200 OK and the response body will contain one or more list Objects in JSON format. If there are no lists for the specified contract, an empty array will be returned in JSON format. On error, the header status code is an error code and the response body contains an error object.

Example Request¶

Request:

GET https://api.crowdynews.com/collection/lists?contract_id=565c4df4056e859526e62257&access_token={your access token}

Response:

HTTP/1.1 200

[
    {
        "_id": "565d4de40d6f659557f64355",
        "created": "2016-03-22T15:01:49.081Z",
        "createdBy": "John Doe",
        "lastModified": "2016-03-22T15:01:49.081Z",
        "lastModifiedBy": "John Doe",
        "active": true,
        "contractId": "565c4df4056e859526e62257",
        "name": "My Profanity List",
        "type": "strings",
        "entries": [
            "shit",
            "fuck"
        ]
    },

    {
        "_id": "565d4de40d6f659557f64356",
        "created": "2016-03-22T15:01:49.081Z",
        "createdBy": "John Doe",
        "lastModified": "2016-03-22T15:01:49.081Z",
        "lastModifiedBy": "John Doe",
        "active": true,
        "contractId": "565c4df4056e859526e62257",
        "name": "My Profanity Pattern List",
        "type": "patterns",
        "entries": [
            "/shi+t*/i",
            "/fu+ck*/i"
        ]
    }
]