Quickstart

The HIO API uses HTTPS and JSON. You need the API base URL for your environment and a credential issued by HIO.

1. Store your connection details

Keep credentials outside source control. The variable names below are examples; use your platform’s approved secret store in deployed applications.

HIO_API_URL="https://api.example.com"
HIO_API_KEY="your-issued-api-key"

2. Request a project

Replace {projectid} with a project identifier your application is authorized to access.

curl --request GET \
  --url "$HIO_API_URL/api/projects/{projectid}" \
  --header "Accept: application/json" \
  --header "x-api-key: $HIO_API_KEY"

3. Use the reference

Open the API reference to find supported paths, parameters, request bodies, and response schemas. The examples on each operation page are generated from the public contract.

Caution

An operation appearing in the reference does not grant access to every project or event. HIO still applies the permissions associated with your credential.