Sign in
portal

Get portal

Read one portal, by its id or slug, or by the resource it serves.

Unreleased and subject to change without notice.

Send exactly one of portal, keyspaceId, or appId. Sending more than one is a 400.

Required Permissions

Your root key must have one of:

  • portal.*.read_portal (to read any portal in the workspace)
  • portal.<portal_id>.read_portal (to read a specific portal)

Without the permission this returns 404, not 403.

post/v2/portal.getPortal

Request body

OR
OR

Example request

{
  "portal": "proj_1234abcd",
  "keyspaceId": "ks_1234abcd",
  "appId": "app_1234abcd"
}

Response

The portal.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "pc_1234abcd",
    "slug": "acme-portal",
    "displayName": "Acme",
    "enabled": true,
    "keyspaceId": "ks_1234abcd",
    "appId": "app_1234abcd",
    "branding": {
      "logoUrl": "https://cdn.example.com/logo.svg",
      "primaryColor": "#6366f1"
    },
    "createdAt": 1719849600000,
    "updatedAt": 1719936000000
  }
}

Changes

Changed in 1 of the 92 revisions of this API.1