Skip to main content
GET
Get the portal context for the caller's token or session

Authorizations

Authorization
string
header
required

A hpt_… customer portal token, as Authorization: Bearer. Stored hashed and looked up by its full SHA-256 hash; shown once at issue. The query string (?token=) is not accepted: a token there ends up in request logs and traces. A browser page trades the token for a portalSession cookie with POST /portal/api/session.

Response

Portal identity and the datasets it exposes.

portal
object
required
customer_id
string
required

The workspace's own identifier for this end customer, taken from the token (portal_tokens.customer_id). Not settable by the customer.

event_types
string[]
required

Dataset names this portal exposes; [] if the stored value is unparseable. An empty array means the portal exposes nothing: no destination can be added, and none of its customers' destinations receives anything.