🔵GET filters

Fetches a list of reporting filters setup by the organisation.

URL

GET https://training.tapintosafety.com.au/api/v2/filters

Parameters

Schema

No parameters available for this endpoint.

Example

curl https://training.tapintosafety.com.au/api/v2/filters \
    -H "Authorization: Bearer $APIKey"

Responses

200 - OK

A list of filters from the database. List may be empty if no filters have been set up.

Schema

Name	Type	Description
entities	array	The list of the filters returned.
┃ id	string	The Id of the filter. Formatted as a GUID.
┃ name	string	The name of the filter.
┗ answers	array	A list of answers that users can choose for the filter.
┃ id	string	The Id of the answer. Formatted as a GUID.
┗ answer	string	The display text of the answer.
page	integer	The current page of results (Starts at 1).
entitiesReturned	integer	The number of filters in the entities array.
totalEntities	integer	The total entities across all pages.
links	array	A list of links relevant to the current request. No links are currently returned with this request.

Example

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Example Filter",
      "answers": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "answer": "Answer 1"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "answer": "Answer 2"
        }
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 1,
  "links": []
}