Sign in

v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB
Portals

Get one Portal

Get a Portal using HRID

get/organizations/{orgId}/environments/{envId}/portals/{hrid}

Response

Portal successfully retrieved

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the portal

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api",
  "name": "Default Portal",
  "navigation": [
    {
      "path": "/projects/alpha",
      "displayName": "Alpha"
    }
  ]
}