Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HorizonIQ Action Items API

Endpoints related to Action Items

HorizonIQ Action Items API is one of 9 APIs that HorizonIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 2023-05-30T22:28:43Z.

Requests are made against a single base URL, https://api.compass.horizoniq.com/{basePath}.

3 operations 3 paths 6 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2023-05-30T22:28:43Z
Base URL
https://api.compass.horizoniq.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HorizonIQ Action Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token issued from the Compass portal (Profile API Tokens). Sent as Authorization: Bearer . See https://compass-horizoniq.readme.io/reference/authentication

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Action Items 3

Endpoints related to Action Items

GET
/action-items/{actionItemUUID}
Get Action Item
getActionItemsByActionItemUUID 2 params → 200400404500
GET
/action-items
List Grouped Action Items
getActionItems 5 params → 200
PATCH
/action-items/acknowledgment
Acknowledge Action Items
updateActionItemsAcknowledgment 1 param body → 200400404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ActionItemsGetModel (27 properties), ActionItemsGroupListModel (6 properties), ActionItemsListModel (6 properties), ActionItemsAckResponseModel (2 properties). Each schema is shown below with its type and property counts.

ActionItemsAckResponseModel
object
2 properties
ActionItemsAckModel
object
1 property
ActionItemsListModel
object
6 properties
ErrorModel
object
1 property
ActionItemsGroupListModel
object
6 properties
ActionItemsGetModel
object
27 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

horizoniq-action-items-api-openapi.yml Raw ↑

Other APIs HorizonIQ publishes across the network.

HorizonIQ Billing API
HorizonIQ Devices API
HorizonIQ Images API
HorizonIQ Managed Firewalls API
HorizonIQ Servers API
HorizonIQ SSL Certificates API
HorizonIQ Support API
HorizonIQ User Accounts API