monitoring

List this account's monitors

Changed on
get/v1/monitors

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/monitors
  • Auth: API key in header X-API-Key

Query parameters

includeCanceledboolean

true also returns canceled monitors. Default false: active monitors only.

Response

The account's monitors, newest first.

Example response

{
  "monitors": [
    {
      "id": "mon_b8f40d7afb9dc0d8",
      "recentAlerts": [
        {
          "id": "hit_7fa176c8889c7569",
          "record": {
            "jurisdiction": "TX",
            "personRef": "prs_3c9e1f0a7b2d4e6f8a1b",
            "recordId": "rec_ab12cd34ef56gh78ij90"
          }
        }
      ]
    }
  ]
}

Changes

  • 72fe5b5ea612Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • a2bbdbc2b735Revision changes
    • info

      the endpoint scheme security BearerAuth was removed from the API