How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flock Safety Custom Hotlists API

The Custom Hotlists API from Flock Safety — 5 operation(s) for custom hotlists.

Flock Safety Custom Hotlists API is one of 10 APIs that Flock Safety publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Hotlists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 8 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against 2 base URLs: https://api.flocksafety.com/api/v3, https://dev-api.flocksafety.com/api/v3.

8 operations 5 paths 13 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://api.flocksafety.com/api/v3
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Flock Safety Custom Hotlists API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It supports OAuth 2.0 (oauth2Auth) using the clientCredentials flow, exposing 2 scopes. It supports OAuth 2.0 (FlockOAuth) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2) using the clientCredentials flow.

  • FlockOAuth — OAuth 2 with the client credentials flow

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Hotlists 8
DELETE
/hotlists/{hotlistId}
Delete a custom hotlist
1 param → 204401403404
GET
/hotlists/{hotlistId}
Retrieve a custom hotlist
1 param → 200401403404
PUT
/hotlists/{hotlistId}
Update a custom hotlist
1 param body → 204401403404413
GET
/hotlists/{hotlistId}/entries
Retrieve a page of entries for a hotlist
3 params → 200401403404
GET
/hotlists
Retrieve custom hotlists
→ 200401403
POST
/hotlists
Create a custom hotlist
body → 201401403413
POST
/hotlists/{hotlistId}/entries/addBatch
Add a batch of entries to a hotlist
1 param body → 200400401403404
POST
/hotlists/{hotlistId}/entries/deleteBatch
Delete a batch of entries from a hotlist
1 param body → 200401403404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are HotlistEntry (7 properties), CreateHotlistEntryRequest (6 properties), Hotlist (3 properties), GetHotlistEntriesResponse (3 properties). Each schema is shown below with its type and property counts.

State
string
HotlistEntryNote
object
Optional note with message field for the hotlist entry
1 property 1 required
CreateHotlistEntriesRequest
object
1 property 1 required
CreateHotlistResponse
object
1 property 1 required
CreateHotlistEntryRequest
object
6 properties 3 required
DeleteHotlistEntriesRequest
object
1 property 1 required
GetHotlistEntriesResponse
object
3 properties 4 required
CreateEntriesResponse
object
1 property 1 required
Hotlist
object
3 properties 4 required
UpdateHotlistRequest
object
2 properties 2 required
CreateHotlistRequest
object
2 properties 2 required
OrgHotlist
object
2 properties
HotlistEntry
object
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flock-safety-custom-hotlists-api-openapi.yml Raw ↑

Other APIs Flock Safety publishes across the network.

Flock Safety Alerts API
Flock Safety CAD Events API
Flock Safety Devices API
Flock Safety LPR Hotlist Alert Subscriptions API
Flock Safety OAuth2 API
Flock Safety Plate Reads API
Flock Safety Tracked Subject Types API
Flock Safety Tracked Subjects API
Flock Safety Vehicle Images API
Where this information came from

This is an independent, third-party profile of Flock Safety Custom Hotlists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.