Get Portal Home Page
GET/api/admin/portal/home
Get the merchant's portal Home page configuration: where buyers land after sign-in (landing_page: catalog or home), every stored announcement (including scheduled and expired ones) and the featured products.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Each announcement carries a computed status — scheduled (starts in the future), live (starts_at <= now < ends_at; a null start is live immediately, a null end never expires) or expired — and live_but_hidden, true for a live announcement beyond the first 3 live ones (buyers see at most 3 at once, in list order). All dates are UTC ISO-8601.
featured_products lists each featured product that still exists, in display order, with sku, name, image_url and a visibility warning: archived (archived products are never shown), not_in_catalog (no portal catalog resolves it, or it is hidden from the portal) or null. Deleted products are left out. Each buyer only sees the featured products their own catalogs include, at their own price.
Requires a staff bearer token with portal management permission.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.