docs_api_get-app.html

<!-- Docs - API - Get App -->
<div class="section">
  <h2><a href="/docs/">Docs</a> : <a href="/docs/api/">API</a> : Get App</h2>

  <p>The <span class="font-semibold">Get App</span> API lets you retrieve all the metadata associated with any of your apps by providing the app ID. The app ID can be obtained from the <a href="https://v1.userbase.com/" target="_blank">Admin panel</a>.</p>

  <pre>
    <code class="language-bash">
      curl 'https://v1.userbase.com/v1/admin/apps/$APP_ID' \
        -XGET \
        -H 'Authorization: Bearer $ACCESS_TOKEN'
    </code>
  </pre>

  <h3 id="params">Parameters</h3>

  <ul>
    <li>
      <span class="field">APP_ID</span> - The app ID to retrieve.
    </li>
    <li>
      <span class="field">ACCESS_TOKEN</span> - Your access token.
    </li>
  </ul>

  <h3 id="result">Result</h3>

  <ul>
    <li><span class="field">appName</span> [string] - The app's name.</li>
    <li><span class="field">appId</span> [string] - The app's unique identifier.</li>
    <li><span class="field">encryptionMode</span> [string] - The app's encryption mode. Can either be 'end-to-end' or 'server-side'. See the <a href="/docs/faq/">FAQ</a> for more on the encryption modes.</li>
    <li><span class="field">creationDate</span> [string] - The timestamp when the app was created.</li>
    <li><span class="field">deleted</span> [string] - The timestamp when the app was deleted, if the app has been deleted.</li>
    <li><span class="field">paymentsMode</span> [string] - The app's payments mode set in your Admin panel. Can be 'disabled', 'test', or 'prod'.</li>
    <li><span class="field">testSubscriptionPlanId</span> [string] - The app's test subscription plan set in your Admin panel.</li>
    <li><span class="field">testTrialPeriodDays</span> [number] - The number of trial days set on the app's test subscription plan in your Stripe Dashboard.</li>
    <li><span class="field">prodSubscriptionPlanId</span> [string] - The app's prod subscription plan set in your Admin panel.</li>
    <li><span class="field">prodTrialPeriodDays</span> [number] - The number of trial days set on the app's prod subscription plan in your Stripe Dashboard.</li>
  </ul>

</div>

<hr>