Miscellaneous

Returns the markup for the interstitial page

Changed on

The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state. It is used by Clerk SDKs when the user's authentication state cannot be immediately determined.

get/public/interstitial

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/public/interstitial
  • Auth: none required

Query parameters

frontendApistring

Please use frontend_api instead

frontend_apistring

The Frontend API key of your instance

publishable_keystring

The publishable key of your instance

proxy_urlstring

The proxy URL of your instance

domainstring

The domain of your instance

sign_in_urlstring

The sign in URL of your instance

use_domain_for_scriptboolean

Whether to use the domain for the script URL

Response

The interstitial page markup

Changes

  • 2025-11-104db0b9e2d5e6Revision changes
    • warning

      deleted the query request parameter application_name

    • warning

      deleted the query request parameter flow

    • warning

      deleted the query request parameter logo_url

  • 2025-11-10e3f2b3a1c567Revision changes
    • info

      added the new optional query request parameter application_name

    • info

      added the new optional query request parameter flow

    • info

      added the new optional query request parameter logo_url