{
  "info": {
    "name": "HodeiShield API 2026-10-27",
    "description": "Read-only HodeiShield public API (/v1), contract version 2026-10-27. Set the collection variable api_key to a tenant API key, an OAuth access token or an MSSP portfolio key; base_url defaults to the production API. Documentation: https://docs.hodeishield.com/api/overview/",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{api_key}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.hodeishield.com",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "",
      "type": "secret"
    }
  ],
  "item": [
    {
      "name": "Vendors",
      "item": [
        {
          "name": "List third parties",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/vendors",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "vendors"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, updated_at, name."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "q",
                  "value": "",
                  "disabled": true,
                  "description": "Case-insensitive substring of the name or the domain."
                },
                {
                  "key": "category",
                  "value": "",
                  "disabled": true,
                  "description": "Exact category match, as the tenant wrote it (case-sensitive). Category is free text with NO closed vocabulary, so there is no list of values to publish: read `category` from `GET /v1/vendors`. To filter by the kind of third party, read `vendor_type` (`x-hs-known-values`)."
                },
                {
                  "key": "active",
                  "value": "",
                  "disabled": true,
                  "description": "Filter by the operational flag."
                },
                {
                  "key": "business_criticality",
                  "value": "",
                  "disabled": true,
                  "description": "Exact criticality match."
                }
              ],
              "variable": []
            },
            "description": "The tenant third-party inventory, newest first by default. Soft-deleted vendors are never returned.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        },
        {
          "name": "Fetch one third party",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/vendors/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "vendors",
                ":id"
              ],
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Vendor identifier."
                }
              ]
            },
            "description": "The same object `listVendors` returns, for a single vendor.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Alerts",
      "item": [
        {
          "name": "List supply-chain alerts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/alerts",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "alerts"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1. Cannot be combined with `cursor`."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "cursor",
                  "value": "",
                  "disabled": true,
                  "description": "Opaque keyset cursor: pass the `next_cursor` of the previous page, with the same `sort`, `order` and filters. Cannot be combined with `page`."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, updated_at."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Filter by the derived status."
                },
                {
                  "key": "severity",
                  "value": "",
                  "disabled": true,
                  "description": "Exact severity match, in the vocabulary the response uses (critical | high | medium | low | info). The legacy Spanish values (critico, alto, medio, bajo, info) are still accepted and mean the same; they are documented as accepted until 2027-01-14, so move to the English ones."
                },
                {
                  "key": "vendor_id",
                  "value": "",
                  "disabled": true,
                  "description": "Only alerts about this vendor."
                },
                {
                  "key": "since",
                  "value": "",
                  "disabled": true,
                  "description": "Only alerts created at or after this RFC 3339 instant."
                },
                {
                  "key": "updated_since",
                  "value": "",
                  "disabled": true,
                  "description": "Only alerts last changed at or after this RFC 3339 instant (`updated_at`), including ones created long before it. Poll changes with `sort=updated_at&order=asc`."
                }
              ],
              "variable": []
            },
            "description": "Alerts raised against the tenant vendors. Poll new alerts with `since` plus `order=asc`, changed ones with `updated_since` plus `sort=updated_at&order=asc`.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        },
        {
          "name": "Fetch one alert",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/alerts/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "alerts",
                ":id"
              ],
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Alert identifier."
                }
              ]
            },
            "description": "The same object `listAlerts` returns, for a single alert.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Risks",
      "item": [
        {
          "name": "List risk-register entries",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/risks",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "risks"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, updated_at, inherent_score, residual_score."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Exact status match. Known values: identified, assessed, treatment_planned, treatment_implemented, closed. Open vocabulary: any other value is matched exactly and matches nothing."
                },
                {
                  "key": "domain",
                  "value": "",
                  "disabled": true,
                  "description": "Exact domain match. Known values: vendor, cyber, data, operational, compliance, concentration, strategic, legal, financial, reputational. Open vocabulary: any other value is matched exactly and matches nothing."
                },
                {
                  "key": "vendor_id",
                  "value": "",
                  "disabled": true,
                  "description": "Only risks linked to this vendor."
                },
                {
                  "key": "min_inherent_score",
                  "value": "",
                  "disabled": true,
                  "description": "Only risks whose inherent score is at least this."
                }
              ],
              "variable": []
            },
            "description": "The tenant risk register, with inherent and residual figures.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        },
        {
          "name": "Fetch one risk-register entry",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/risks/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "risks",
                ":id"
              ],
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Risk identifier."
                }
              ]
            },
            "description": "The same object `listRisks` returns, for a single entry.\n\nRequired scope: `supply_risk:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Compliance",
      "item": [
        {
          "name": "List control status for a framework",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/compliance/controls",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "compliance",
                "controls"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "control_code",
                  "disabled": true,
                  "description": "Field to order by. One of: control_code, last_evaluated_at."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "framework",
                  "value": "",
                  "disabled": true,
                  "description": "Framework slug. One of: nis2, ens, iso27001, dora, gdpr, soc2, iso42001, nistcsf, pcidss, euaiact, hipaa, cmmc, cyberessentials, uaeia, sama, saudiecc, ndpa."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Exact status match. Known values: covered, partial, missing. Open vocabulary: any other value is matched exactly and matches nothing."
                }
              ],
              "variable": []
            },
            "description": "Per-control status of one framework. Requires the read scope OF THAT FRAMEWORK: `compliance.<framework>:read`.\n\nRequired scope: `compliance.<framework>:read`. Published in `/v1` since 2026-09-20."
          }
        },
        {
          "name": "Framework posture summary",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/compliance/frameworks/:framework",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "compliance",
                "frameworks",
                ":framework"
              ],
              "query": [],
              "variable": [
                {
                  "key": "framework",
                  "value": "",
                  "description": "Framework slug. One of: nis2, ens, iso27001, dora, gdpr, soc2, iso42001, nistcsf, pcidss, euaiact, hipaa, cmmc, cyberessentials, uaeia, sama, saudiecc, ndpa."
                }
              ]
            },
            "description": "Counts of evaluated controls by status for one framework, for a dashboard tile. Requires `compliance.<framework>:read`.\n\nRequired scope: `compliance.<framework>:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Evidence",
      "item": [
        {
          "name": "List security evidence",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/evidence",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "evidence"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, valid_until."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "evidence_type",
                  "value": "",
                  "disabled": true,
                  "description": "Exact type match."
                },
                {
                  "key": "source_type",
                  "value": "",
                  "disabled": true,
                  "description": "Exact producer match."
                },
                {
                  "key": "vendor_id",
                  "value": "",
                  "disabled": true,
                  "description": "Only evidence about this vendor."
                },
                {
                  "key": "expiring_before",
                  "value": "",
                  "disabled": true,
                  "description": "Only evidence with a `valid_until` strictly before this `YYYY-MM-DD`."
                }
              ],
              "variable": []
            },
            "description": "Evidence held for the tenant. Use `expiring_before` plus `sort=valid_until&order=asc` for a renewal queue.\n\nRequired scope: `evidence:read`. Published in `/v1` since 2026-09-20."
          }
        },
        {
          "name": "Fetch one evidence item",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/evidence/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "evidence",
                ":id"
              ],
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Evidence identifier."
                }
              ]
            },
            "description": "The same object `listEvidence` returns, for a single item.\n\nRequired scope: `evidence:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Endpoints",
      "item": [
        {
          "name": "List enrolled endpoint agents",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/endpoints",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "endpoints"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "enrolled_at",
                  "disabled": true,
                  "description": "Field to order by. One of: enrolled_at, last_seen_at, producer."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Exact status match."
                },
                {
                  "key": "silent_since",
                  "value": "",
                  "disabled": true,
                  "description": "Agents last seen before this RFC 3339 instant, or never seen at all."
                }
              ],
              "variable": []
            },
            "description": "The endpoint agents enrolled in this tenant. `silent_since` selects the ones that have gone quiet, including those that never reported.\n\nRequired scope: `endpoints:read`. Published in `/v1` since 2026-09-20."
          }
        }
      ]
    },
    {
      "name": "Portfolio",
      "item": [
        {
          "name": "List the client tenants of an MSSP portfolio",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/portfolio/tenants",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "portfolio",
                "tenants"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "name",
                  "disabled": true,
                  "description": "Field to order by. One of: name, slug."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                }
              ],
              "variable": []
            },
            "description": "Every tenant the presented PORTFOLIO key may select with `X-HS-Tenant`: the MSSP’s own tenants (its internal one included) and every tenant of its active client organisations, active or not, licensed or not, narrowed to the key’s client subset when it has one. Membership is evaluated live on every request. Only a portfolio key (`hsp_…`) can call this operation; this operation never takes `X-HS-Tenant`.\n\nRequired scope: `portfolio:read`. Published in `/v1` since 2026-10-16."
          }
        }
      ]
    },
    {
      "name": "Identity",
      "item": [
        {
          "name": "Describe the calling credential",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/me",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "me"
              ],
              "query": [],
              "variable": []
            },
            "description": "Who the presented credential is: its type and scopes, and the tenant and organisation it reads (a tenant API key or an OAuth token), for an OAuth token also the signed-in user (`user`: its own id and name, and its email only when the token carries the `email` scope; never another user’s; null for any key), or the MSSP organisation it belongs to and how many tenants it can reach (a portfolio key; the tenants themselves are on `GET /v1/portfolio/tenants`). It describes the caller only: no other tenant, no secret, never the key or its hash. Any valid credential may call it: it requires NO scope, and it uses the same authentication and the same rate limits as every other operation. It never takes `X-HS-Tenant`.\n\nRequired scope: `none (any valid credential)`. Published in `/v1` since 2026-10-17."
          }
        }
      ]
    },
    {
      "name": "Reports",
      "item": [
        {
          "name": "List generated reports",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/reports",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "reports"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, period_end."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "report_type",
                  "value": "",
                  "disabled": true,
                  "description": "Exact type match. Known values: monthly, vendor_risk, nis2_compliance, ens, cyberbrief, compliance, security_posture, board_report. Open vocabulary: any other value is matched exactly and matches nothing."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Exact status match. Known values: generating, completed, failed. Open vocabulary: any other value is matched exactly and matches nothing."
                },
                {
                  "key": "since",
                  "value": "",
                  "disabled": true,
                  "description": "Only reports created at or after this RFC 3339 instant."
                }
              ],
              "variable": []
            },
            "description": "The reports generated for the tenant, newest first by default. Poll for new ones with `since` plus `order=asc`; download one with `downloadReport` once its `status` is `completed`.\n\nRequired scope: `reports:read`. Published in `/v1` since 2026-10-19."
          }
        },
        {
          "name": "Fetch one report",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/reports/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "reports",
                ":id"
              ],
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Report identifier."
                }
              ]
            },
            "description": "The same object `listReports` returns, for a single report, plus the formats it can be downloaded in now (`download_formats`).\n\nRequired scope: `reports:read`. Published in `/v1` since 2026-10-19."
          }
        },
        {
          "name": "Download a report file",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/reports/:id/download",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "reports",
                ":id",
                "download"
              ],
              "query": [
                {
                  "key": "format",
                  "value": "pdf",
                  "disabled": true,
                  "description": "File format, one of: pdf, xlsx. Defaults to pdf. `getReport` lists the formats a report can be served in (`download_formats`)."
                },
                {
                  "key": "locale",
                  "value": "en",
                  "disabled": true,
                  "description": "Language of the file, one of: es, en, de, fr, it, eu. Defaults to en."
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Report identifier."
                }
              ]
            },
            "description": "The report rendered as a file (PDF or XLSX), returned as the response body with `Content-Disposition: attachment`; never a link. Each delivery is recorded in the tenant’s audit trail with the credential that received it. A report that is not `completed`, a format its content has no renderer for (see `download_formats` in `getReport`) and a file over the size cap are a 409.\n\nRequired scope: `reports:read`. Published in `/v1` since 2026-10-19."
          }
        }
      ]
    },
    {
      "name": "Changes",
      "item": [
        {
          "name": "List change requests",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-HS-Tenant",
                "value": "",
                "disabled": true,
                "description": "The tenant to read, as its id (a UUID, any case). REQUIRED with a portfolio key (`hsp_…`); with a tenant API key or an OAuth token, optional and accepted only when it equals the credential’s own tenant. Never a slug."
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/v1/changes",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "v1",
                "changes"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "disabled": true,
                  "description": "1-based page number. Defaults to 1."
                },
                {
                  "key": "per_page",
                  "value": "50",
                  "disabled": true,
                  "description": "Items per page, 1..200. Defaults to 50."
                },
                {
                  "key": "sort",
                  "value": "created_at",
                  "disabled": true,
                  "description": "Field to order by. One of: created_at, planned_start_at, implemented_at."
                },
                {
                  "key": "order",
                  "value": "desc",
                  "disabled": true,
                  "description": "Sort direction. Defaults to desc."
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true,
                  "description": "Exact status match."
                },
                {
                  "key": "change_type",
                  "value": "",
                  "disabled": true,
                  "description": "Exact type match."
                },
                {
                  "key": "category",
                  "value": "",
                  "disabled": true,
                  "description": "Exact category match."
                },
                {
                  "key": "created_from",
                  "value": "",
                  "disabled": true,
                  "description": "Only changes created on or after this `YYYY-MM-DD` (UTC)."
                },
                {
                  "key": "created_to",
                  "value": "",
                  "disabled": true,
                  "description": "Only changes created on or before this `YYYY-MM-DD` (UTC)."
                }
              ],
              "variable": []
            },
            "description": "The tenant's change-management register: status, type, risk, planned and carried-out dates, the review outcome and how many approval decisions each change holds. Read only; free text and people are not published.\n\nRequired scope: `changes:read`. Published in `/v1` since 2026-10-27."
          }
        }
      ]
    }
  ]
}
