FLflocksafety
Custom Hotlists

Retrieve a page of entries for a hotlist

Changed on

Retrieve a page of entries for the hotlist with the given ID

get/hotlists/{hotlistId}/entries

Request

  • Base URL
    https://api.flocksafety.com/api/v3
  • URL
    https://api.flocksafety.com/api/v3/hotlists/{hotlistId}/entries
  • 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

Query parameters

limitinteger

The maximum number of hotlist entries to return

cursorstring

A cursor for the next page of results

Response

The hotlist entries were successfully retrieved.

totalResultsinteger
nextPagestring nullable

Example response

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

Changes