> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the portal context for the bearer token



## OpenAPI

````yaml /openapi.json get /portal/api/me
openapi: 3.1.0
info:
  title: Hookie API
  version: 1.0.0
  summary: Capture, route and deliver webhooks.
  description: >-
    Hookie exposes three HTTP surfaces.


    **Ingest + streaming** is the public plane. A path-form endpoint URL
    authenticates by its own high-entropy slug — there is no key, token or
    cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes.
    Whenever the URL names a dataset the payload is stored whole into it;
    project mapping rules are evaluated on exactly one shape, `POST
    /v1/ingest/{ingest_key}` with no dataset segment.


    **The customer portal API** is a separate, token-authed surface for your end
    customers, scoped to one portal and one customer.


    **The admin API** drives the console. It accepts either a browser session or
    an OAuth bearer token from a connected coding agent — the same routes, the
    same validation, the same audit trail. An agent's authority is its user's
    workspace role narrowed to the scopes granted in the console.


    This document is generated from the request handlers and adversarially
    verified against them.
  contact:
    name: Hookie
    url: https://hookie.ai
  license:
    name: Proprietary
    url: https://hookie.ai/legal/terms
servers:
  - url: https://app.hookie.ai
    description: Production
  - url: https://app.preview.hookie.ai
    description: Preview
security: []
tags:
  - name: Ingest
    description: Send events to Hookie.
  - name: Streaming
    description: Tail events in real time over SSE or WebSocket.
  - name: Portal
    description: Token-authed surface for your end customers.
  - name: Projects
    description: Projects and their settings.
  - name: Routing
    description: Rules, endpoints, datasets and records.
  - name: Delivery
    description: Destinations, deliveries and replay.
  - name: Workflows
    description: Multi-step workflows, triggers and AI agents.
  - name: Observability
    description: Search, correlation, stats and the audit log.
  - name: Workspace
    description: Members, connected agents, SSO and billing.
paths:
  /portal/api/me:
    get:
      tags:
        - Customer Portal
      summary: Get the portal context for the bearer token
      operationId: getPortalMe
      parameters:
        - name: token
          in: query
          required: false
          description: >-
            Portal access token (hpt_…), as an alternative to the
            `Authorization: Bearer` header. The header is checked first; the
            query parameter is used only when no Bearer header is present.
          schema:
            type: string
      responses:
        '200':
          description: Portal identity and the datasets it exposes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - portal
                  - customer_id
                  - event_types
                properties:
                  portal:
                    type: object
                    required:
                      - name
                      - branding
                    properties:
                      name:
                        type: string
                        description: >-
                          portal_configs.name — the display name the workspace
                          gave this portal.
                      branding:
                        description: >-
                          portal_configs.branding parsed from JSON (e.g. {
                          logo_url?, color? }); {} if the stored value is
                          unparseable.
                        type: object
                        additionalProperties: true
                  customer_id:
                    type: string
                    description: >-
                      The workspace's own identifier for this end customer,
                      taken from the token (portal_tokens.customer_id). Not
                      settable by the customer.
                  event_types:
                    type: array
                    items:
                      type: string
                    description: >-
                      Dataset names this portal exposes; [] if the stored value
                      is unparseable. An empty array means no dataset
                      restriction is applied to new destinations.
              example:
                portal:
                  name: Acme Webhooks
                  branding:
                    color: '#8B5CF6'
                customer_id: cus_9182
                event_types:
                  - orders
                  - invoices
        '401':
          description: >-
            Missing, malformed, revoked, expired token, or the portal is
            disabled. Body: {"error":"Invalid or expired portal token"}.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - portalTokenHeader: []
        - portalTokenQuery: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable reason.
        retry_after:
          type: integer
          description: Seconds to wait. Present on 429.
        upgrade_url:
          type: string
          format: uri
          description: Present only on a monthly-quota 429.
  securitySchemes:
    portalTokenHeader:
      type: http
      scheme: bearer
      description: >-
        A `hpt_…` customer portal token, as `Authorization: Bearer`. Stored
        hashed; shown once at issue.
    portalTokenQuery:
      type: apiKey
      in: query
      name: token
      description: >-
        The same portal token in the query string, for embedding the portal in
        an iframe where a header cannot be set.

````