Early bird discounts live! Claim your offer

get_portal_url

Compute the subscriber portal URL for a project — {frontend_url}/{handle}. Always reflects the current handle.

Purpose

Compute the subscriber portal URL for a project — {frontend_url}/{handle}. Always reflects the current handle, so updating the handle invalidates old portal URLs automatically.

Required ability

distribution:read

Input schema

{
  "type": "object",
  "required": ["project_id"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project whose portal URL to return."
    }
  }
}

Output shape

{
  "data": {
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "handle": "research-premium",
    "portal_url": "https://my.subscriby.net/research-premium"
  }
}

Example prompts

"What's the portal URL for project 7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13?"

"Give me the sharable link to my Research Premium project."

Failure modes

  • RESOURCE_NOT_FOUNDproject_id is not a valid UUID, or the project belongs to a team outside the token's scope.
  • TOKEN_MISSING_ABILITY — token lacks distribution:read.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request