[GET] Get incident categories

Modified on Tue, 11 Feb at 3:45 AM

https://api.s7risk.com

The Incident API provides well constructed high-quality, highly-tailored and scalable threat intelligence data.

`GET /incident-categories`Get incident categories

This endpoint gets all available incident categories. The categories returned can be filtered by adding search parameters to your request.

HTTP Request

curl -X GET 'https://api.s7risk.com/incident-categories' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  -d 'search=criminal' \
  -d 'sort=desc' \
  -d 'page=4' \
  -d 'pageSize=10' \
  --compressed

Headers

Name	Type	Required	Description
`Authorization`	string	✔️	Your authentication token (see the Auth API section for more information)

Query Parameters

Name	Type	Description
`search`	string	Search categories using the given search term
`sort`	string	Sort the results by the given properties. Available options `asc` or `desc`. If no sort order is specified then results are sorted by their relevancy
`page`	int	A paginated result set. Defaults to `1`
`pageSize`	int	A limited result set. Defaults to `100`

HTTP Response

{
    "data": [
        {
            "id": "b1a4f5b5-0c49-486a-9819-87a7b71e0328",
            "name": "Protest",
            "colour": "#1AB491"
        },
        {
            "id": "37c046ee-ff01-413f-8d20-1cfba90aa7a7",
            "name": "Suicide/Complex",
            "colour": "#E34637"
        }
    ]
}

Success

Code	Status	Description
200	Success	Returns a body containing all valid incident categories

Errors

Code	Status	Description
401	Unauthorized	Expired or Invalid Authentication token
422	Unprocessable Entity	Incorrect or invalid search parameter