Get a project's portal design

curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/portal-design \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

The published document, the draft when there is one, when each last moved, and a fresh preview address, or null for a project without a handle. Every key of the fourteen sections comes back in the stored shape PUT takes, so a design read here can be changed and sent back. draft is null and has_draft false while nothing is drafted.

Requires ability

project:view

The token must hold this ability, or the call is refused with 403.

MCP tool

get_portal_design

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

Responses

200OKapplication/json

The published design, the draft and the preview address.

data*

The response's payload.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/portal-design"

{  "data": {    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "published": {      "preset": "midnight",      "color_mode": "light",      "accent": "#22d3ee",      "accent_secondary": null,      "background": "#0f172a",      "grid": true,      "surface": "#1e293b",      "text": "#cbd5e1",      "heading": "#f8fafc",      "muted": "#94a3b8",      "tagline": "Weekly research notes and the members lounge",      "social_links": [],      "font_display": "space-grotesk",      "font_body": "inter",      "heading_case": "uppercase",      "type_scale": "regular",      "radius": "round",      "button_style": "pill",      "button_fill": "dark",      "button_case": "uppercase",      "shadow": "strong",      "card_border": false,      "arrangement": "sidebar_left",      "content_width": "regular",      "sticky_sidebar": true,      "plan_grid": "list",      "plan_density": "roomy",      "plans_heading": true,      "metrics_subscribers": true,      "metrics_followers": true,      "metrics_threshold": 0,      "plans_title": null,      "plans_subtitle": null,      "label_login": null,      "label_share": null,      "label_subscribe": null,      "checkout_title": null,      "checkout_subtitle": null,      "checkout_note": null,      "success_title": null,      "success_message": null,      "perks_title": null,      "perks": [],      "faq_title": null,      "faq": [],      "about_name": null,      "about_bio": null,      "custom_button_label": null,      "custom_button_url": null,      "footer_refund_url": null,      "footer_contact_url": null,      "footer_imprint_url": null,      "footer_line": null,      "footer_help": true,      "announcement_text": null,      "announcement_url": null,      "announcement_starts_at": null,      "announcement_ends_at": null,      "video_url": null,      "gallery_title": null,      "gallery": [],      "testimonials_title": null,      "testimonials": [],      "sidebar_items": [        {          "key": "tagline",          "shown": true        },        {          "key": "metrics",          "shown": true        },        {          "key": "buttons",          "shown": true        },        {          "key": "description",          "shown": true        },        {          "key": "social_links",          "shown": true        },        {          "key": "footer",          "shown": true        }      ],      "content_blocks": [        {          "key": "perks",          "shown": true        },        {          "key": "about",          "shown": true        },        {          "key": "faq",          "shown": true        },        {          "key": "video",          "shown": true        },        {          "key": "gallery",          "shown": true        },        {          "key": "testimonials",          "shown": true        }      ],      "locale_switcher": true,      "featured_plan_id": null,      "coupon_box": "always",      "share_button": true,      "share_networks": [        "bluesky",        "buffer",        "email",        "facebook",        "flipboard",        "line",        "linkedin",        "mix",        "pinterest",        "reddit",        "telegram",        "threads",        "tumblr",        "x",        "vk",        "whatsapp",        "xing"      ],      "login_button": true,      "social_proof": false,      "seats_badges": true,      "seo_indexable": true,      "seo_social_card": true,      "pixel_meta": null,      "pixel_ga4": null,      "pixel_tiktok": null,      "pixel_google_ads": null,      "custom_css": null,      "seo_title_suffix": null,      "seo_description": null,      "social_card_url": null,      "default_locale": null,      "locales": [        "en",        "fr",        "es",        "it",        "hi",        "bn",        "de",        "pt",        "tr",        "si"      ]    },    "draft": null,    "has_draft": false,    "draft_updated_at": null,    "published_at": "2026-10-26T16:40:08+00:00",    "preview_url": "https://my.subscriby.net/research-premium?preview=7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13&expires=1793032000&signature=9c1d…"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: PortalDesignResource;}export interface PortalDesignResource {  project_id: string;  published: PortalDesignDocumentResource;  draft: PortalDesignDocumentResource2 | null;  has_draft: boolean;  draft_updated_at: string | null;  published_at: string | null;  preview_url: string | null;}export interface PortalDesignDocumentResource {  preset: string;  color_mode: string;  accent: string;  accent_secondary: string | null;  background: string;  grid: boolean;  surface: string;  text: string;  heading: string;  muted: string;  tagline: string | null;  social_links: unknown[];  font_display: string;  font_body: string;  heading_case: string;  type_scale: string;  radius: string;  button_style: string;  button_fill: string;  button_case: string;  shadow: string;  card_border: boolean;  arrangement: string;  content_width: string;  sticky_sidebar: boolean;  plan_grid: string;  plan_density: string;  plans_heading: boolean;  metrics_subscribers: boolean;  metrics_followers: boolean;  metrics_threshold: number;  plans_title: string | null;  plans_subtitle: string | null;  label_login: string | null;  label_share: string | null;  label_subscribe: string | null;  checkout_title: string | null;  checkout_subtitle: string | null;  checkout_note: string | null;  success_title: string | null;  success_message: string | null;  perks_title: string | null;  perks: string[];  faq_title: string | null;  faq: unknown[];  about_name: string | null;  about_bio: string | null;  custom_button_label: string | null;  custom_button_url: string | null;  footer_refund_url: string | null;  footer_contact_url: string | null;  footer_imprint_url: string | null;  footer_line: string | null;  footer_help: boolean;  announcement_text: string | null;  announcement_url: string | null;  announcement_starts_at: string | null;  announcement_ends_at: string | null;  video_url: string | null;  gallery_title: string | null;  gallery: string[];  testimonials_title: string | null;  testimonials: unknown[];  sidebar_items: unknown[];  content_blocks: unknown[];  locale_switcher: boolean;  featured_plan_id: string | null;  coupon_box: string;  share_button: boolean;  share_networks: unknown[];  login_button: boolean;  social_proof: boolean;  seats_badges: boolean;  seo_indexable: boolean;  seo_social_card: boolean;  pixel_meta: string | null;  pixel_ga4: string | null;  pixel_tiktok: string | null;  pixel_google_ads: string | null;  custom_css: string | null;  seo_title_suffix: string | null;  seo_description: string | null;  social_card_url: string | null;  default_locale: string | null;  locales: unknown[];}export interface PortalDesignDocumentResource2 {  preset: string;  color_mode: string;  accent: string;  accent_secondary: string | null;  background: string;  grid: boolean;  surface: string;  text: string;  heading: string;  muted: string;  tagline: string | null;  social_links: unknown[];  font_display: string;  font_body: string;  heading_case: string;  type_scale: string;  radius: string;  button_style: string;  button_fill: string;  button_case: string;  shadow: string;  card_border: boolean;  arrangement: string;  content_width: string;  sticky_sidebar: boolean;  plan_grid: string;  plan_density: string;  plans_heading: boolean;  metrics_subscribers: boolean;  metrics_followers: boolean;  metrics_threshold: number;  plans_title: string | null;  plans_subtitle: string | null;  label_login: string | null;  label_share: string | null;  label_subscribe: string | null;  checkout_title: string | null;  checkout_subtitle: string | null;  checkout_note: string | null;  success_title: string | null;  success_message: string | null;  perks_title: string | null;  perks: string[];  faq_title: string | null;  faq: unknown[];  about_name: string | null;  about_bio: string | null;  custom_button_label: string | null;  custom_button_url: string | null;  footer_refund_url: string | null;  footer_contact_url: string | null;  footer_imprint_url: string | null;  footer_line: string | null;  footer_help: boolean;  announcement_text: string | null;  announcement_url: string | null;  announcement_starts_at: string | null;  announcement_ends_at: string | null;  video_url: string | null;  gallery_title: string | null;  gallery: string[];  testimonials_title: string | null;  testimonials: unknown[];  sidebar_items: unknown[];  content_blocks: unknown[];  locale_switcher: boolean;  featured_plan_id: string | null;  coupon_box: string;  share_button: boolean;  share_networks: unknown[];  login_button: boolean;  social_proof: boolean;  seats_badges: boolean;  seo_indexable: boolean;  seo_social_card: boolean;  pixel_meta: string | null;  pixel_ga4: string | null;  pixel_tiktok: string | null;  pixel_google_ads: string | null;  custom_css: string | null;  seo_title_suffix: string | null;  seo_description: string | null;  social_card_url: string | null;  default_locale: string | null;  locales: unknown[];}

Get a project's portal design

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Path Parameters

Responses