Get a Filter List

Get information for a single filter list.

Endpoint

GET https://api.crowdynews.com/collection/lists/{id}

Request Parameters

URL PARAMETER VALUE DESCRIPTION
id The resource ID of the list. The consumer that wants to retrieve the list must have access to the contract said list belongs to, otherwise this action is forbidden.
QUERY PARAMETER VALUE DESCRIPTION
access_token A valid OAuth access token with the correct permission(s).

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body will contain a list object 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/565d4de40d6f659557f64356?access_token={your access token}

Response:

HTTP/1.1 200

{
    "_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"
    ]
}

Additional Resources