FLflocksafety
Custom Hotlists

Retrieve a custom hotlist

Changed on

Retrieve a hotlist with the given ID

get/hotlists/{hotlistId}

Request

  • Base URL
    https://api.flocksafety.com/api/v3
  • URL
    https://api.flocksafety.com/api/v3/hotlists/{hotlistId}
  • Auth
    • OpenID Connect (https://login.flocksafety.com/.well-known/openid-configuration, scopes: custom-hotlists:read)
    • or OAuth 2
      Client credentials
      Token URL: https://api.flocksafety.com/oauth/token scopes: custom-hotlists:read

Path parameters

hotlistIdstring uuid required

hotlist uuid

Response

The hotlist was successfully retrieved.

idstring required
namestring required

Example response

{
  "entries": [
    {
      "note": {
        "message": "Vehicle observed at 5th and Main. Contact Det. Smith at 555-0123."
      }
    }
  ]
}

Changes